diff --git a/docs/installation.md b/docs/installation.md index 51cc7569..955d8b46 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -249,115 +249,115 @@ You can use Visio on https://meet.127.0.0.1.nip.io from the local device. The pr These are the environmental options available on meet backend. -| Option | Description | default | -| ----------------------------------------------- | ---------------------------------------- |---------------------------------------------------------------------------------------------------------------------------------------------------------------| -| DATA_DIR | Data directory location | /data | -| DJANGO_ALLOWED_HOSTS | Hosts that are allowed | [] | -| DJANGO_SECRET_KEY | Secret key used for Django security | | -| DJANGO_SILENCED_SYSTEM_CHECKS | Silence Django system checks | [] | -| DJANGO_ALLOW_UNSECURE_USER_LISTING | Allow unsecure user listing | false | -| DB_ENGINE | Database engine used | django.db.backends.postgresql_psycopg2 | -| DB_NAME | Name of the database | meet | -| DB_USER | User used to connect to database | dinum | -| DB_PASSWORD | Password used to connect to the database | pass | -| DB_HOST | Hostname of the database | localhost | -| DB_PORT | Port to connect to database | 5432 | -| STORAGES_STATICFILES_BACKEND | Static file serving engine | whitenoise.storage.CompressedManifestStaticFilesStorage | -| AWS_S3_ENDPOINT_URL | S3 host endpoint | | -| AWS_S3_ACCESS_KEY_ID | S3 access key | | -| AWS_S3_SECRET_ACCESS_KEY | S3 secret key | | -| AWS_S3_REGION_NAME | S3 region | | -| AWS_STORAGE_BUCKET_NAME | S3 bucket name | meet-media-storage | -| DJANGO_LANGUAGE_CODE | Default language | en-us | -| REDIS_URL | Redis endpoint | redis://redis:6379/1 | -| SESSION_COOKIE_AGE | Session cookie expiration in seconds | 43200 (12 hours) | -| REQUEST_ENTRY_THROTTLE_RATES | Entry request throttle rates | 150/minute | -| CREATION_CALLBACK_THROTTLE_RATES | Creation callback throttle rates | 600/minute | -| SPECTACULAR_SETTINGS_ENABLE_DJANGO_DEPLOY_CHECK | Enable Django deploy check | false | -| CSRF_TRUSTED_ORIGINS | CSRF trusted origins list | [] | -| FRONTEND_CUSTOM_CSS_URL | URL of an additional CSS file to load in the frontend app. If set, a `` tag with this URL as href is added to the `` of the frontend app | | -| FRONTEND_ANALYTICS | Analytics information | {} | -| FRONTEND_SUPPORT | Crisp frontend support configuration | {} | -| FRONTEND_SILENCE_LIVEKIT_DEBUG | Silence LiveKit debug logs | false | -| FRONTEND_IS_SILENT_LOGIN_ENABLED | Enable silent login feature | true | -| FRONTEND_FEEDBACK | Frontend feedback configuration | {} | -| FRONTEND_USE_FRENCH_GOV_FOOTER | Show the French government footer in the homepage | false | -| FRONTEND_USE_PROCONNECT_BUTTON | Show a "Login with ProConnect" button in the homepage instead of a "Login" button | false | -| DJANGO_EMAIL_BACKEND | Email backend library | django.core.mail.backends.smtp.EmailBackend | -| DJANGO_EMAIL_HOST | Host of the email server | | -| DJANGO_EMAIL_HOST_USER | User to connect to the email server | | -| DJANGO_EMAIL_HOST_PASSWORD | Password to connect to the email server | | -| DJANGO_EMAIL_PORT | Port to connect to the email server | | -| DJANGO_EMAIL_USE_TLS | Enable TLS on email connection | false | -| DJANGO_EMAIL_USE_SSL | Enable SSL on email connection | false | -| DJANGO_EMAIL_FROM | Email from account | from@example.com | -| EMAIL_BRAND_NAME | Email branding name | | -| EMAIL_SUPPORT_EMAIL | Support email address | | -| EMAIL_LOGO_IMG | Email logo image | | -| EMAIL_DOMAIN | Email domain | | -| EMAIL_APP_BASE_URL | Email app base URL | | -| DJANGO_CORS_ALLOW_ALL_ORIGINS | Allow all CORS origins | false | -| DJANGO_CORS_ALLOWED_ORIGINS | Origins to allow (string list) | [] | -| DJANGO_CORS_ALLOWED_ORIGIN_REGEXES | Origins to allow (regex patterns) | [] | -| SENTRY_DSN | Sentry server DSN | | -| DJANGO_CELERY_BROKER_URL | Celery broker host | redis://redis:6379/0 | -| DJANGO_CELERY_BROKER_TRANSPORT_OPTIONS | Celery broker options | {} | -| OIDC_CREATE_USER | Create OIDC user if not exists | true | -| OIDC_VERIFY_SSL | Verify SSL for OIDC | true | -| OIDC_FALLBACK_TO_EMAIL_FOR_IDENTIFICATION | Fallback to email for identification | false | -| OIDC_RP_SIGN_ALGO | Token verification algorithm used by OIDC | RS256 | -| OIDC_RP_CLIENT_ID | OIDC client ID | meet | -| OIDC_RP_CLIENT_SECRET | OIDC client secret | | -| OIDC_OP_JWKS_ENDPOINT | OIDC endpoint for JWKS | | -| OIDC_OP_AUTHORIZATION_ENDPOINT | OIDC endpoint for authorization | | -| OIDC_OP_TOKEN_ENDPOINT | OIDC endpoint for token | | -| OIDC_OP_USER_ENDPOINT | OIDC endpoint for user | | -| OIDC_OP_USER_ENDPOINT_FORMAT | OIDC endpoint format (AUTO, JWT, JSON) | AUTO | -| OIDC_OP_LOGOUT_ENDPOINT | OIDC endpoint for logout | | -| OIDC_AUTH_REQUEST_EXTRA_PARAMS | Extra parameters for OIDC request | {} | -| OIDC_RP_SCOPES | OIDC scopes | openid email | -| OIDC_USE_NONCE | Use nonce for OIDC | true | -| OIDC_REDIRECT_REQUIRE_HTTPS | Require HTTPS for OIDC | false | -| OIDC_REDIRECT_ALLOWED_HOSTS | Allowed redirect hosts for OIDC | [] | -| OIDC_STORE_ID_TOKEN | Store OIDC ID token | true | -| OIDC_REDIRECT_FIELD_NAME | Redirect field for OIDC | returnTo | -| OIDC_USERINFO_FULLNAME_FIELDS | Full name claim from OIDC token | ["given_name", "usual_name"] | -| OIDC_USERINFO_SHORTNAME_FIELD | Short name claim from OIDC token | given_name | -| OIDC_USERINFO_ESSENTIAL_CLAIMS | Required claims from OIDC token | [] | -| LOGIN_REDIRECT_URL | Login redirect URL | | -| LOGIN_REDIRECT_URL_FAILURE | Login redirect URL for failure | | -| LOGOUT_REDIRECT_URL | URL to redirect to on logout | | -| ALLOW_LOGOUT_GET_METHOD | Allow logout through GET method | true | -| LIVEKIT_API_KEY | LiveKit API key | | -| LIVEKIT_API_SECRET | LiveKit API secret | | -| LIVEKIT_API_URL | LiveKit API URL | | -| LIVEKIT_VERIFY_SSL | Verify SSL for LiveKit connections | true | -| RESOURCE_DEFAULT_ACCESS_LEVEL | Default resource access level for rooms | public | -| ALLOW_UNREGISTERED_ROOMS | Allow usage of unregistered rooms | true | -| RECORDING_ENABLE | Record meeting option | false | -| RECORDING_OUTPUT_FOLDER | Folder to store meetings | recordings | -| RECORDING_WORKER_CLASSES | Worker classes for recording | {"screen_recording": "core.recording.worker.services.VideoCompositeEgressService","transcript": "core.recording.worker.services.AudioCompositeEgressService"} | -| RECORDING_EVENT_PARSER_CLASS | Storage event engine for recording | core.recording.event.parsers.MinioParser | -| RECORDING_ENABLE_STORAGE_EVENT_AUTH | Enable storage event authorization | true | -| RECORDING_STORAGE_EVENT_ENABLE | Enable recording storage events | false | -| RECORDING_STORAGE_EVENT_TOKEN | Recording storage event token | | -| RECORDING_EXPIRATION_DAYS | Recording expiration in days | | -| SCREEN_RECORDING_BASE_URL | Screen recording base URL | | -| SUMMARY_SERVICE_ENDPOINT | Summary service endpoint | | -| SUMMARY_SERVICE_API_TOKEN | API token for summary service | | -| SIGNUP_NEW_USER_TO_MARKETING_EMAIL | Signup users to marketing emails | false | -| MARKETING_SERVICE_CLASS | Marketing service class | core.services.marketing.BrevoMarketingService | -| BREVO_API_KEY | Brevo API key for marketing emails | | -| BREVO_API_CONTACT_LIST_IDS | Brevo API contact list IDs | [] | -| DJANGO_BREVO_API_CONTACT_ATTRIBUTES | Brevo contact attributes | {"VISIO_USER": true} | -| BREVO_API_TIMEOUT | Brevo timeout in seconds | 1 | -| LOBBY_KEY_PREFIX | Lobby key prefix | room_lobby | -| LOBBY_WAITING_TIMEOUT | Lobby waiting timeout in seconds | 3 | -| LOBBY_DENIED_TIMEOUT | Lobby deny timeout in seconds | 5 | -| LOBBY_ACCEPTED_TIMEOUT | Lobby accept timeout in seconds | 21600 (6 hours) | -| LOBBY_NOTIFICATION_TYPE | Lobby notification types | participantWaiting | -| LOBBY_COOKIE_NAME | Lobby cookie name | lobbyParticipantId | -| ROOM_CREATION_CALLBACK_CACHE_TIMEOUT | Room creation callback cache timeout | 600 (10 minutes) | -| ROOM_TELEPHONY_ENABLED | Enable SIP telephony feature | false | -| ROOM_TELEPHONY_PIN_LENGTH | Telephony PIN length | 10 | -| ROOM_TELEPHONY_PIN_MAX_RETRIES | Telephony PIN maximum retries | 5 | +| Option | Description | default | +| ----------------------------------------------- |------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| +| DATA_DIR | Data directory location | /data | +| DJANGO_ALLOWED_HOSTS | Hosts that are allowed | [] | +| DJANGO_SECRET_KEY | Secret key used for Django security | | +| DJANGO_SILENCED_SYSTEM_CHECKS | Silence Django system checks | [] | +| DJANGO_ALLOW_UNSECURE_USER_LISTING | Allow unsecure user listing | false | +| DB_ENGINE | Database engine used | django.db.backends.postgresql_psycopg2 | +| DB_NAME | Name of the database | meet | +| DB_USER | User used to connect to database | dinum | +| DB_PASSWORD | Password used to connect to the database | pass | +| DB_HOST | Hostname of the database | localhost | +| DB_PORT | Port to connect to database | 5432 | +| STORAGES_STATICFILES_BACKEND | Static file serving engine | whitenoise.storage.CompressedManifestStaticFilesStorage | +| AWS_S3_ENDPOINT_URL | S3 host endpoint | | +| AWS_S3_ACCESS_KEY_ID | S3 access key | | +| AWS_S3_SECRET_ACCESS_KEY | S3 secret key | | +| AWS_S3_REGION_NAME | S3 region | | +| AWS_STORAGE_BUCKET_NAME | S3 bucket name | meet-media-storage | +| DJANGO_LANGUAGE_CODE | Default language | en-us | +| REDIS_URL | Redis endpoint | redis://redis:6379/1 | +| SESSION_COOKIE_AGE | Session cookie expiration in seconds | 43200 (12 hours) | +| REQUEST_ENTRY_THROTTLE_RATES | Entry request throttle rates | 150/minute | +| CREATION_CALLBACK_THROTTLE_RATES | Creation callback throttle rates | 600/minute | +| SPECTACULAR_SETTINGS_ENABLE_DJANGO_DEPLOY_CHECK | Enable Django deploy check | false | +| CSRF_TRUSTED_ORIGINS | CSRF trusted origins list | [] | +| FRONTEND_CUSTOM_CSS_URL | URL of an additional CSS file to load in the frontend app. If set, a `` tag with this URL as href is added to the `` of the frontend app | | +| FRONTEND_ANALYTICS | Analytics information | {} | +| FRONTEND_SUPPORT | Crisp frontend support configuration | {} | +| FRONTEND_SILENCE_LIVEKIT_DEBUG | Silence LiveKit debug logs | false | +| FRONTEND_IS_SILENT_LOGIN_ENABLED | Enable silent login feature | true | +| FRONTEND_FEEDBACK | Frontend feedback configuration | {} | +| FRONTEND_USE_FRENCH_GOV_FOOTER | Show the French government footer in the homepage | false | +| FRONTEND_USE_PROCONNECT_BUTTON | Show a "Login with ProConnect" button in the homepage instead of a "Login" button | false | +| DJANGO_EMAIL_BACKEND | Email backend library | django.core.mail.backends.smtp.EmailBackend | +| DJANGO_EMAIL_HOST | Host of the email server | | +| DJANGO_EMAIL_HOST_USER | User to connect to the email server | | +| DJANGO_EMAIL_HOST_PASSWORD | Password to connect to the email server | | +| DJANGO_EMAIL_PORT | Port to connect to the email server | | +| DJANGO_EMAIL_USE_TLS | Enable TLS on email connection | false | +| DJANGO_EMAIL_USE_SSL | Enable SSL on email connection | false | +| DJANGO_EMAIL_FROM | Email from account | from@example.com | +| EMAIL_BRAND_NAME | Email branding name | | +| EMAIL_SUPPORT_EMAIL | Support email address | | +| EMAIL_LOGO_IMG | Email logo image | | +| EMAIL_DOMAIN | Email domain | | +| EMAIL_APP_BASE_URL | Email app base URL | | +| DJANGO_CORS_ALLOW_ALL_ORIGINS | Allow all CORS origins | false | +| DJANGO_CORS_ALLOWED_ORIGINS | Origins to allow (string list) | [] | +| DJANGO_CORS_ALLOWED_ORIGIN_REGEXES | Origins to allow (regex patterns) | [] | +| SENTRY_DSN | Sentry server DSN | | +| DJANGO_CELERY_BROKER_URL | Celery broker host | redis://redis:6379/0 | +| DJANGO_CELERY_BROKER_TRANSPORT_OPTIONS | Celery broker options | {} | +| OIDC_CREATE_USER | Create OIDC user if not exists | true | +| OIDC_VERIFY_SSL | Verify SSL for OIDC | true | +| OIDC_FALLBACK_TO_EMAIL_FOR_IDENTIFICATION | Fallback to email for identification | false | +| OIDC_RP_SIGN_ALGO | Token verification algorithm used by OIDC | RS256 | +| OIDC_RP_CLIENT_ID | OIDC client ID | meet | +| OIDC_RP_CLIENT_SECRET | OIDC client secret | | +| OIDC_OP_JWKS_ENDPOINT | OIDC endpoint for JWKS | | +| OIDC_OP_AUTHORIZATION_ENDPOINT | OIDC endpoint for authorization | | +| OIDC_OP_TOKEN_ENDPOINT | OIDC endpoint for token | | +| OIDC_OP_USER_ENDPOINT | OIDC endpoint for user | | +| OIDC_OP_USER_ENDPOINT_FORMAT | OIDC endpoint format (AUTO, JWT, JSON) | AUTO | +| OIDC_OP_LOGOUT_ENDPOINT | OIDC endpoint for logout | | +| OIDC_AUTH_REQUEST_EXTRA_PARAMS | Extra parameters for OIDC request | {} | +| OIDC_RP_SCOPES | OIDC scopes | openid email | +| OIDC_USE_NONCE | Use nonce for OIDC | true | +| OIDC_REDIRECT_REQUIRE_HTTPS | Require HTTPS for OIDC | false | +| OIDC_REDIRECT_ALLOWED_HOSTS | Allowed redirect hosts for OIDC | [] | +| OIDC_STORE_ID_TOKEN | Store OIDC ID token | true | +| OIDC_REDIRECT_FIELD_NAME | Redirect field for OIDC | returnTo | +| OIDC_USERINFO_FULLNAME_FIELDS | Full name claim from OIDC token | ["given_name", "usual_name"] | +| OIDC_USERINFO_SHORTNAME_FIELD | Short name claim from OIDC token | given_name | +| OIDC_USERINFO_ESSENTIAL_CLAIMS | Required claims from OIDC token | [] | +| LOGIN_REDIRECT_URL | Login redirect URL | | +| LOGIN_REDIRECT_URL_FAILURE | Login redirect URL for failure | | +| LOGOUT_REDIRECT_URL | URL to redirect to on logout | | +| ALLOW_LOGOUT_GET_METHOD | Allow logout through GET method | true | +| LIVEKIT_API_KEY | LiveKit API key | | +| LIVEKIT_API_SECRET | LiveKit API secret | | +| LIVEKIT_API_URL | LiveKit API URL | | +| LIVEKIT_VERIFY_SSL | Verify SSL for LiveKit connections | true | +| RESOURCE_DEFAULT_ACCESS_LEVEL | Default resource access level for rooms | public | +| ALLOW_UNREGISTERED_ROOMS | Allow usage of unregistered rooms | true | +| RECORDING_ENABLE | Record meeting option | false | +| RECORDING_OUTPUT_FOLDER | Folder to store meetings | recordings | +| RECORDING_WORKER_CLASSES | Worker classes for recording | {"screen_recording": "core.recording.worker.services.VideoCompositeEgressService","transcript": "core.recording.worker.services.AudioCompositeEgressService"} | +| RECORDING_EVENT_PARSER_CLASS | Storage event engine for recording | core.recording.event.parsers.MinioParser | +| RECORDING_ENABLE_STORAGE_EVENT_AUTH | Enable storage event authorization | true | +| RECORDING_STORAGE_EVENT_ENABLE | Enable recording storage events | false | +| RECORDING_STORAGE_EVENT_TOKEN | Recording storage event token | | +| RECORDING_EXPIRATION_DAYS | Recording expiration in days | | +| SCREEN_RECORDING_BASE_URL | Screen recording base URL | | +| SUMMARY_SERVICE_ENDPOINT | Summary service endpoint | | +| SUMMARY_SERVICE_API_TOKEN | API token for summary service | | +| SIGNUP_NEW_USER_TO_MARKETING_EMAIL | Signup users to marketing emails | false | +| MARKETING_SERVICE_CLASS | Marketing service class | core.services.marketing.BrevoMarketingService | +| BREVO_API_KEY | Brevo API key for marketing emails | | +| BREVO_API_CONTACT_LIST_IDS | Brevo API contact list IDs | [] | +| DJANGO_BREVO_API_CONTACT_ATTRIBUTES | Brevo contact attributes | {"VISIO_USER": true} | +| BREVO_API_TIMEOUT | Brevo timeout in seconds | 1 | +| LOBBY_KEY_PREFIX | Lobby key prefix | room_lobby | +| LOBBY_WAITING_TIMEOUT | Lobby waiting timeout in seconds | 3 | +| LOBBY_DENIED_TIMEOUT | Lobby deny timeout in seconds | 5 | +| LOBBY_ACCEPTED_TIMEOUT | Lobby accept timeout in seconds | 21600 (6 hours) | +| LOBBY_NOTIFICATION_TYPE | Lobby notification types | participantWaiting | +| LOBBY_COOKIE_NAME | Lobby cookie name | lobbyParticipantId | +| ROOM_CREATION_CALLBACK_CACHE_TIMEOUT | Room creation callback cache timeout | 600 (10 minutes) | +| ROOM_TELEPHONY_ENABLED | Enable SIP telephony feature | false | +| ROOM_TELEPHONY_PIN_LENGTH | Telephony PIN length | 10 | +| ROOM_TELEPHONY_PIN_MAX_RETRIES | Telephony PIN maximum retries | 5 |