envy/compose.yml at main · front-matter/envy · 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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
# Envy defines project-level documentation configuration.
x-envy:
    HUGO_TITLE: Envy
    HUGO_PARAMS_DESCRIPTION: >
        Envy is an environment variable manager for Docker. This website renders the automatic documentation for the compose.yml example file included with the GitHub repo.
    HUGO_LANGUAGE_CODE: en-US
    HUGO_IGNORE_LOGS:
        - warning-goldmark-raw-html
    HUGO_MARKUP_GOLDMARK_UNSAFE: "true"
# Base defines shared environment variables for web and worker.
# Link: https://inveniordm.docs.cern.ch/operate/customize/i18n-and-l10n/
x-set-base: &base
    INVENIO_BABEL_DEFAULT_LOCALE: "${INVENIO_BABEL_DEFAULT_LOCALE:-en}"
    INVENIO_ISO639_LANGUAGES: "${INVENIO_ISO639_LANGUAGES:-fr,de,es,pt}"
    INVENIO_BABEL_DEFAULT_TIMEZONE: "${INVENIO_BABEL_DEFAULT_TIMEZONE:-UTC}"
    INVENIO_LOGGING_CONSOLE_LEVEL: "${INVENIO_LOGGING_CONSOLE_LEVEL:-INFO}"
    INVENIO_RDM_CITATION_STYLES: "${INVENIO_RDM_CITATION_STYLES:-apa,chicago-author-date,harvard-cite-them-right,ieee,vancouver}"
    INVENIO_RDM_CITATION_STYLES_DEFAULT: "${INVENIO_RDM_CITATION_STYLES_DEFAULT:-}"
    INVENIO_SEARCH_HOSTS: "${INVENIO_SEARCH_HOSTS:-['search:9200']}"
    INVENIO_SEARCH_INDEX_PREFIX: "${INVENIO_SEARCH_INDEX_PREFIX:-invenio-rdm-}"
    # TEST_HARDCODED_VAR is a hardcoded test variable and cannot be edited in generated compose.yml files.
    TEST_HARDCODED_VAR: "locked-value"
    # TEST_REQUIRED_VAR is a required test variable and must be provided.
    TEST_REQUIRED_VAR: "${TEST_REQUIRED_VAR:-?required-value}"
# Authentication defines authentication and account-security configuration.
# Link: https://auth-wiki.logto.io/openid-connect-discovery
x-set-authentication: &authentication
    INVENIO_ACCOUNTS_DEFAULT_USER_VISIBILITY: "${INVENIO_ACCOUNTS_DEFAULT_USER_VISIBILITY:-restricted}"
    INVENIO_ACCOUNTS_LOCAL_LOGIN_ENABLED: "${INVENIO_ACCOUNTS_LOCAL_LOGIN_ENABLED:-false}"
    INVENIO_OAUTHCLIENT_AUTO_REDIRECT_TO_EXTERNAL_LOGIN: "${INVENIO_OAUTHCLIENT_AUTO_REDIRECT_TO_EXTERNAL_LOGIN:-false}"
    INVENIO_OIDC_APP_CREDENTIALS_CONSUMER_KEY: "${INVENIO_OIDC_APP_CREDENTIALS_CONSUMER_KEY:-}"
    # OpenID Connect issuer URL for authentication.
    # Link: https://auth-wiki.logto.io/openid-connect-discovery
    INVENIO_OIDC_ISSUER: "${INVENIO_OIDC_ISSUER:-}"
    # Allow users to change their password.
    INVENIO_SECURITY_CHANGEABLE: "${INVENIO_SECURITY_CHANGEABLE:-true}"
    INVENIO_SECURITY_CONFIRMABLE: "${INVENIO_SECURITY_CONFIRMABLE:-true}"
    INVENIO_SECURITY_LOGIN_WITHOUT_CONFIRMATION: "${INVENIO_SECURITY_LOGIN_WITHOUT_CONFIRMATION:-true}"
    INVENIO_SECURITY_RECOVERABLE: "${INVENIO_SECURITY_RECOVERABLE:-true}"
    INVENIO_SECURITY_REGISTERABLE: "${INVENIO_SECURITY_REGISTERABLE:-true}"
    # Enable tracking of basic user login statistics.
    INVENIO_SECURITY_TRACKABLE: "${INVENIO_SECURITY_TRACKABLE:-true}"
    INVENIO_USERPROFILES_READ_ONLY: "${INVENIO_USERPROFILES_READ_ONLY:-true}"
# Cache defines Redis/Valkey configuration for broker and cache.
x-set-cache: &cache
    INVENIO_ACCOUNTS_SESSION_REDIS_URL: "${INVENIO_ACCOUNTS_SESSION_REDIS_URL:-}"
    INVENIO_CELERY_BROKER_URL: "${INVENIO_CELERY_BROKER_URL:-}"
    INVENIO_CELERY_RESULT_BACKEND: "${INVENIO_CELERY_RESULT_BACKEND:-}"
    INVENIO_RATELIMIT_STORAGE_URL: "${INVENIO_RATELIMIT_STORAGE_URL:-}"
    INVENIO_CACHE_REDIS_URL: "${INVENIO_CACHE_REDIS_URL:-}"
# DB defines database configuration.
x-set-db: &db
    POSTGRES_HOST: "${POSTGRES_HOST:-postgres}"
    POSTGRES_DB: "${POSTGRES_DB:-inveniordm}"
    POSTGRES_USER: "${POSTGRES_USER:-postgres}"
    POSTGRES_PASSWORD:
    INVENIO_SQLALCHEMY_DATABASE_URI: "postgresql+psycopg2://${POSTGRES_USER:-inveniordm}:${POSTGRES_PASSWORD:-}@${POSTGRES_HOST:-postgres}:5432/${POSTGRES_DB:-inveniordm}"
# DOI defines DOI registration configuration.
# Link: https://inveniordm.docs.cern.ch/operate/customize/dois/
x-set-doi: &doi
    INVENIO_DATACITE_DATACENTER_SYMBOL: "${INVENIO_DATACITE_DATACENTER_SYMBOL:-}"
    INVENIO_DATACITE_ENABLED: "${INVENIO_DATACITE_ENABLED:-false}"
    INVENIO_DATACITE_PREFIX: "${INVENIO_DATACITE_PREFIX:-}"
    INVENIO_DATACITE_TEST_MODE: "${INVENIO_DATACITE_TEST_MODE:-false}"
    INVENIO_DATACITE_USERNAME: "${INVENIO_DATACITE_USERNAME:-}"
    INVENIO_RDM_ALLOW_EXTERNAL_DOI_VERSIONING: "${INVENIO_RDM_ALLOW_EXTERNAL_DOI_VERSIONING:-false}"
    INVENIO_RDM_ALLOW_METADATA_ONLY_RECORDS: "${INVENIO_RDM_ALLOW_METADATA_ONLY_RECORDS:-true}"
    INVENIO_RDM_ALLOW_RESTRICTED_RECORDS: "${INVENIO_RDM_ALLOW_RESTRICTED_RECORDS:-true}"
# Mail defines email configuration.
# Link: https://inveniordm.docs.cern.ch/operate/customize/emails/
x-set-mail: &mail
    INVENIO_MAIL_SUPPRESS_SEND: "${INVENIO_MAIL_SUPPRESS_SEND:-}"
    INVENIO_MAIL_SERVER: "${INVENIO_MAIL_SERVER:-127.0.0.2}"
    INVENIO_MAIL_PORT: "${INVENIO_MAIL_PORT:-}"
    INVENIO_MAIL_USE_TLS: "${INVENIO_MAIL_USE_TLS:-false}"
    INVENIO_MAIL_USE_SSL: "${INVENIO_MAIL_USE_SSL:-false}"
    INVENIO_MAIL_USERNAME: "${INVENIO_MAIL_USERNAME:-info}"
    INVENIO_MAIL_PASSWORD:
    INVENIO_ADMIN_EMAIL: "${INVENIO_ADMIN_EMAIL:-info@inveniosoftware.com}"
    INVENIO_SECURITY_EMAIL_SENDER: "${INVENIO_SECURITY_EMAIL_SENDER:-{INVENIO_ADMIN_EMAIL}}"
# S3 defines S3-compatible storage backend configuration.
# Link: https://inveniordm.docs.cern.ch/operate/customize/file-uploads/s3/
x-set-s3: &s3
    INVENIO_S3_ENDPOINT_URL: "${INVENIO_S3_ENDPOINT_URL:-}"
    INVENIO_S3_BUCKET_NAME: "${INVENIO_S3_BUCKET_NAME:-}"
    INVENIO_S3_ACCESS_KEY_ID: "${INVENIO_S3_ACCESS_KEY_ID:-}"
    INVENIO_S3_SECRET_ACCESS_KEY:
    INVENIO_S3_REGION_NAME: "${INVENIO_S3_REGION_NAME:-us-east-1}"
# Search defines OpenSearch configuration.
x-set-search: &search
    DISABLE_INSTALL_DEMO_CONFIG: "${DISABLE_INSTALL_DEMO_CONFIG:-true}"
    DISABLE_SECURITY_PLUGIN: "${DISABLE_SECURITY_PLUGIN:-true}"
    # OPENSEARCH_JAVA_OPTS defines Java memory settings for the production service.
    OPENSEARCH_JAVA_OPTS: "${OPENSEARCH_JAVA_OPTS:--Xms512m -Xmx512m}"
    bootstrap.memory_lock: "${BOOTSTRAP_MEMORY_LOCK:-true}"
    # discovery.type enables cluster mode for better performance and resilience.
    discovery.type: "${DISCOVERY_TYPE:-single-node}"
# Web defines web configuration.
# Link: https://inveniordm.docs.cern.ch/operate/customize/look-and-feel/
x-set-web: &web
    INVENIO_SITE_UI_URL: "${INVENIO_SITE_UI_URL:-https://localhost}"
    INVENIO_SITE_API_URL: "${INVENIO_SITE_API_URL:-https://localhost/api}"
    INVENIO_TRUSTED_HOSTS: "${INVENIO_TRUSTED_HOSTS:-['0.0.0.0', 'localhost', '127.0.0.1']}"
    INVENIO_THEME_FRONTPAGE_TITLE: "${INVENIO_THEME_FRONTPAGE_TITLE:-InvenioRDM Starter}"
    INVENIO_THEME_FRONTPAGE_SUBTITLE: "${INVENIO_THEME_FRONTPAGE_SUBTITLE:-A starter project for the turn-key research data management repository.}"
    INVENIO_THEME_LOGO: "${INVENIO_THEME_LOGO:-images/invenio-rdm.svg}"
    INVENIO_THEME_SHOW_FRONTPAGE_INTRO_SECTION: "${INVENIO_THEME_SHOW_FRONTPAGE_INTRO_SECTION:-false}"
    INVENIO_THEME_SITENAME: "${INVENIO_THEME_SITENAME:-InvenioRDM Starter}"
services:
    cache:
        image: valkey/valkey:7.2.5-bookworm
        command: [ "valkey-server", "--loglevel", "warning" ]
    # Describes db service configuration.
    db:
        image: postgres:17.4-bookworm
        profiles: [ dev, staging ]
        environment:
            !!merge <<: [ *db ]
    # Describes proxy service configuration.
    proxy:
        image: caddy:2.10
        profiles: [ dev, staging ]
    # Describes search service configuration.
    # Link: https://docs.opensearch.org/latest/install-and-configure/install-opensearch/docker/
    search:
        image: opensearchproject/opensearch:2.18.0
        environment:
            !!merge <<: [ *search ]
    # Describes web service configuration.
    web:
        image: ghcr.io/front-matter/invenio-rdm-starter:latest
        platform: linux/amd64
        environment:
            !!merge <<: [ *base, *web, *authentication, *mail, *s3 ]
    worker:
        image: ghcr.io/front-matter/invenio-rdm-starter:latest
        platform: linux/amd64
        command: [ "celery", "-A", "invenio_app.celery", "worker", "--beat", "--schedule=/tmp/celerybeat-schedule", "--events", "--loglevel=WARNING" ]
        environment:
            !!merge <<: [ *base, *cache, *doi, *mail, *s3 ]