flowo/env.example at main · zhanghaomiao/flowo · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
# Server Configuration
# Full grouped reference: docs/reference/environment-variables.md
PORT=3100
DOMAIN=localhost
PROTOCOL=http
# Required in production. Use a long random value and keep it stable after
# the first deployment. Changing it invalidates existing login/reset tokens
# and user API tokens.
SECRET_KEY=change-this-to-a-long-random-secret
TZ=Asia/Shanghai

# Database Configuration
POSTGRES_DB=flowo_logs
POSTGRES_USER=flowo
POSTGRES_PASSWORD=flowo_password
POSTGRES_HOST=db
# POSTGRES_PORT=5432

# Docker Permissions (Optional)
# If not set, containers will run as root to avoid volume mount permission issues.
# UID=1000
# GID=1000

# Path Configuration
# FLOWO_WORKING_PATH: Local path on host where Snakemake runs and logs are stored.
FLOWO_WORKING_PATH=/home/user/flowo-working-path
# CONTAINER_MOUNT_PATH: The path inside the container where the host path is mounted.
CONTAINER_MOUNT_PATH=/flowo-data
# CATALOG_EXPORT_DIR: Export cache directory inside the container.
# Default is ${CONTAINER_MOUNT_PATH}/.flowo_exported_catalogs if not set.
# CATALOG_EXPORT_DIR=/flowo-data/.flowo_exported_catalogs
# CATALOG_BLOB_DIR: Sidecar directory for binary catalog files (e.g. .fq.gz) that
# are not stored in PostgreSQL. Default: ${CONTAINER_MOUNT_PATH}/.flowo_catalog_blobs.
# CATALOG_BLOB_DIR=/flowo-data/.flowo_catalog_blobs
# CATALOG_BLOB_MAX_BYTES: Maximum size of a single imported catalog binary file.
# Default: 250 MiB.
# CATALOG_BLOB_MAX_BYTES=262144000
# CATALOG_IMPORT_MAX_BYTES: Maximum total size of files imported from one catalog.
# Default: 1 GiB.
# CATALOG_IMPORT_MAX_BYTES=1073741824

# SNAKEMAKE_WORKFLOW_TEMPLATE_DIR: Persistent cache for the official
# snakemake-workflow-template (separate from per-user catalogs). If unset: uses
# ${CONTAINER_MOUNT_PATH}/snakemake-workflow-template when that path exists and is
# writable (typical in Docker); otherwise ${FLOWO_WORKING_PATH}/snakemake-workflow-template.
# On startup, Flowo runs ensure: shallow git clone when there is no repo, or
# git pull --ff-only when .git exists but the tree is incomplete — same family of
# operations as Web UI "Pull / update". A valid checkout (has workflow/) is never
# touched on restart (no automatic pull).
# Requires git and GitHub access unless you pre-populate this directory (offline:
# copy the official snakemake-workflow-template tree here so workflow/ exists).
# SNAKEMAKE_WORKFLOW_TEMPLATE_DIR=/flowo-data/snakemake-workflow-template

# FLOWO_HOST: The external URL of this server (defaults to PROTOCOL://DOMAIN:PORT).
# FLOWO_HOST=http://localhost:3100

# Frontend Vite dev server (compose.dev.yml / `cd frontend && npm run dev`):
# Comma-separated Host headers allowed when the browser hits Vite through a reverse
# proxy (e.g. Caddy → flowo-frontend:5173). Avoid allowedHosts: true in vite.config.
# VITE_DEV_ALLOWED_HOSTS=flowo.example.com,dev.example.com

# First superuser (optional — for operators who deploy without reading docs)
# If BOTH are set and the database has no superuser yet, the container entrypoint
# creates one superuser, then you can sign in at the web UI.
# Remove or blank these after the first successful deploy; never commit real values.
# FLOWO_BOOTSTRAP_ADMIN_EMAIL=admin@example.com
# FLOWO_BOOTSTRAP_ADMIN_PASSWORD=change-me-immediately

# Security Settings
# For the default Caddy same-origin deployment, localhost is enough.
# If frontend and backend are deployed on different origins, replace this with
# the exact frontend URL(s), e.g. ["https://flowo.example.com"].
BACKEND_CORS_ORIGINS=["http://localhost","http://localhost:3100"]