diff --git a/application/configuration/configuring.md b/application/configuration/configuring.md index e081e52..e7b62fe 100644 --- a/application/configuration/configuring.md +++ b/application/configuration/configuring.md @@ -37,55 +37,99 @@ The `app/env-default.php` file contains the default settings that are passed. He '', - 'CHEVERETO_ASSET_STORAGE_ACCOUNT_NAME' => '', - 'CHEVERETO_ASSET_STORAGE_BUCKET' => '', - 'CHEVERETO_ASSET_STORAGE_KEY' => '', - 'CHEVERETO_ASSET_STORAGE_NAME' => 'assets', - 'CHEVERETO_ASSET_STORAGE_REGION' => '', - 'CHEVERETO_ASSET_STORAGE_SECRET' => '', - 'CHEVERETO_ASSET_STORAGE_SERVER' => '', - 'CHEVERETO_ASSET_STORAGE_SERVICE' => '', - 'CHEVERETO_ASSET_STORAGE_TYPE' => 'local', - 'CHEVERETO_ASSET_STORAGE_URL' => '', - 'CHEVERETO_CONTEXT' => '', - 'CHEVERETO_DB_DRIVER' => 'mysql', - 'CHEVERETO_DB_HOST' => 'localhost', - 'CHEVERETO_DB_NAME' => '', - 'CHEVERETO_DB_PASS' => '', - 'CHEVERETO_DB_PDO_ATTRS' => '[]', - 'CHEVERETO_DB_PORT' => '3306', - 'CHEVERETO_DB_TABLE_PREFIX' => 'chv_', - 'CHEVERETO_DB_USER' => '', - 'CHEVERETO_DEBUG_LEVEL' => '1', - 'CHEVERETO_ENABLE_BULK_IMPORTER' => '1', - 'CHEVERETO_ENABLE_CHECK_UPDATES' => '1', - 'CHEVERETO_ENABLE_HTACCESS_CHECK' => '0', - 'CHEVERETO_ENABLE_LOCAL_STORAGE' => '1', - 'CHEVERETO_ENABLE_PHP_PAGES' => '0', - 'CHEVERETO_ENABLE_UPDATE_CLI' => '1', - 'CHEVERETO_ENABLE_UPDATE_HTTP' => '1', - 'CHEVERETO_ENCRYPTION_KEY' => '', - 'CHEVERETO_ERROR_LOG' => 'php://stderr', - 'CHEVERETO_HEADER_CLIENT_IP' => '', - 'CHEVERETO_HOSTNAME_PATH' => '/', - 'CHEVERETO_HOSTNAME' => 'localhost', - 'CHEVERETO_HTTPS' => '1', - 'CHEVERETO_IMAGE_FORMATS_AVAILABLE' => '["JPEG","PNG","BMP","GIF","WEBP"]', - 'CHEVERETO_IMAGE_LIBRARY' => 'imagick', - 'CHEVERETO_MAX_ALBUMS' => '0', - 'CHEVERETO_MAX_EXECUTION_TIME_SECONDS' => '30', - 'CHEVERETO_MAX_IMAGES' => '0', - 'CHEVERETO_MAX_MEMORY_SIZE' => '512M', - 'CHEVERETO_MAX_POST_SIZE' => '64M', - 'CHEVERETO_MAX_UPLOAD_SIZE' => '64M', - 'CHEVERETO_MAX_USER_ALBUMS_LIST' => '300', - 'CHEVERETO_MAX_USERS' => '0', - 'CHEVERETO_SERVICING' => 'server', - 'CHEVERETO_SESSION_SAVE_HANDLER' => 'files', - 'CHEVERETO_SESSION_SAVE_PATH' => '/tmp', - 'CHEVERETO_BINARY_FFMPEG' => 'ffmpeg', - 'CHEVERETO_BINARY_FFPROBE' => 'ffprobe', + 'CHEVERETO_BINARY_FFMPEG' => 'ffmpeg', + 'CHEVERETO_BINARY_FFPROBE' => 'ffprobe', + 'CHEVERETO_CONTEXT' => '', + 'CHEVERETO_DB_DRIVER' => 'mysql', + 'CHEVERETO_DB_HOST' => 'localhost', + 'CHEVERETO_DB_NAME' => '', + 'CHEVERETO_DB_PASS' => '', + 'CHEVERETO_DB_PDO_ATTRS' => '[]', + 'CHEVERETO_DB_PORT' => '3306', + 'CHEVERETO_DB_TABLE_PREFIX' => 'chv_', + 'CHEVERETO_DB_USER' => '', + 'CHEVERETO_DEBUG_LEVEL' => '1', + 'CHEVERETO_EDITION' => 'pro', + 'CHEVERETO_ENABLE_API_GUEST' => '1', + 'CHEVERETO_ENABLE_BANNERS' => '1', + 'CHEVERETO_ENABLE_BULK_IMPORTER' => '1', + 'CHEVERETO_ENABLE_CAPTCHA' => '1', + 'CHEVERETO_ENABLE_CDN' => '1', + 'CHEVERETO_ENABLE_CONSENT_SCREEN' => '1', + 'CHEVERETO_ENABLE_COOKIE_COMPLIANCE' => '1', + 'CHEVERETO_ENABLE_DEBUG' => '1', + 'CHEVERETO_ENABLE_EXPOSE_PAID_FEATURES' => '1', + 'CHEVERETO_ENABLE_EXTERNAL_SERVICES' => '1', + 'CHEVERETO_ENABLE_EXTERNAL_STORAGE' => '1', + 'CHEVERETO_ENABLE_FAVICON' => '1', + 'CHEVERETO_ENABLE_FOLLOWERS' => '1', + 'CHEVERETO_ENABLE_FORCE_POWERED_BY_FOOTER' => '0', + 'CHEVERETO_ENABLE_HTACCESS_CHECK' => '0', + 'CHEVERETO_ENABLE_IP_BANS' => '1', + 'CHEVERETO_ENABLE_LANGUAGE_CHOOSER' => '1', + 'CHEVERETO_ENABLE_LIKES' => '1', + 'CHEVERETO_ENABLE_LOCAL_STORAGE' => '1', + 'CHEVERETO_ENABLE_LOGIN_PROVIDERS' => '1', + 'CHEVERETO_ENABLE_LOGO_CUSTOM' => '1', + 'CHEVERETO_ENABLE_MODERATION' => '1', + 'CHEVERETO_ENABLE_NEWS_CHECK' => '1', + 'CHEVERETO_ENABLE_NOTIFICATIONS' => '1', + 'CHEVERETO_ENABLE_PAGES' => '1', + 'CHEVERETO_ENABLE_PHP_PAGES' => '0', + 'CHEVERETO_ENABLE_POWERED_BY_SETTING' => '1', + 'CHEVERETO_ENABLE_PUP_CUSTOM_URL' => '1', + 'CHEVERETO_ENABLE_ROUTING' => '1', + 'CHEVERETO_ENABLE_SEO_ALBUM_URL' => '1', + 'CHEVERETO_ENABLE_SEO_IMAGE_URL' => '1', + 'CHEVERETO_ENABLE_SERVICE_AKISMET' => '1', + 'CHEVERETO_ENABLE_SERVICE_MODERATECONTENT' => '1', + 'CHEVERETO_ENABLE_SERVICE_PROJECTARACHNID' => '1', + 'CHEVERETO_ENABLE_SERVICE_STOPFORUMSPAM' => '1', + 'CHEVERETO_ENABLE_STOPWORDS' => '1', + 'CHEVERETO_ENABLE_UPDATE_CHECK' => '1', + 'CHEVERETO_ENABLE_UPDATE_CLI' => '1', + 'CHEVERETO_ENABLE_UPDATE_HTTP' => '1', + 'CHEVERETO_ENABLE_UPLOAD_FLOOD_PROTECTION' => '1', + 'CHEVERETO_ENABLE_UPLOAD_PLUGIN' => '1', + 'CHEVERETO_ENABLE_UPLOAD_URL' => '1', + 'CHEVERETO_ENABLE_UPLOAD_WATERMARK' => '1', + 'CHEVERETO_ENABLE_USERS' => '1', + 'CHEVERETO_ENABLE_XRDEBUG' => '0', + 'CHEVERETO_ENCRYPTION_KEY' => '', + 'CHEVERETO_ERROR_LOG_CLI' => '', + 'CHEVERETO_ERROR_LOG_CRON' => '', + 'CHEVERETO_ERROR_LOG' => 'php://stderr', + 'CHEVERETO_HEADER_CLIENT_IP' => '', + 'CHEVERETO_HOSTNAME_PATH' => '/', + 'CHEVERETO_HOSTNAME' => 'localhost', + 'CHEVERETO_HTTPS' => '1', + 'CHEVERETO_IMAGE_FORMATS_AVAILABLE' => '["AVIF","JPEG","PNG","BMP","GIF","WEBP"]', + 'CHEVERETO_IMAGE_LIBRARY' => 'imagick', + 'CHEVERETO_MAX_ADMINS' => '0', + 'CHEVERETO_MAX_ALBUMS' => '0', + 'CHEVERETO_MAX_CATEGORIES' => '0', + 'CHEVERETO_MAX_EXECUTION_TIME_SECONDS' => '30', + 'CHEVERETO_MAX_FILES' => '0', + 'CHEVERETO_MAX_LOGIN_PROVIDERS' => '0', + 'CHEVERETO_MAX_MANAGERS' => '0', + 'CHEVERETO_MAX_MEMORY_SIZE' => '512M', + 'CHEVERETO_MAX_PAGES' => '0', + 'CHEVERETO_MAX_POST_SIZE' => '100M', + 'CHEVERETO_MAX_STORAGES' => '0', + 'CHEVERETO_MAX_TAGS_PER_FILE' => '0', + 'CHEVERETO_MAX_TAGS_PER_LISTING' => '0', + 'CHEVERETO_MAX_TAGS' => '0', + 'CHEVERETO_MAX_UPLOAD_SIZE' => '100M', + 'CHEVERETO_MAX_USER_ALBUMS_LIST' => '500', + 'CHEVERETO_MAX_USERS' => '0', + 'CHEVERETO_MIN_STORAGES_ACTIVE' => '0', + 'CHEVERETO_SERVICING' => 'server', + 'CHEVERETO_SESSION_SAVE_HANDLER' => 'files', + 'CHEVERETO_SESSION_SAVE_PATH' => '/tmp', + 'CHEVERETO_XRDEBUG_HOST' => 'localhost', + 'CHEVERETO_XRDEBUG_HTTPS' => '0', + 'CHEVERETO_XRDEBUG_KEY' => '', + 'CHEVERETO_XRDEBUG_PORT' => '27420', ]; ``` ::: diff --git a/application/configuration/environment.md b/application/configuration/environment.md index 79e9f78..d4323ad 100644 --- a/application/configuration/environment.md +++ b/application/configuration/environment.md @@ -1,24 +1,12 @@ # Environment -## Assets variables - -Environment variables for storing assets that can be uploaded to any of the supported external storage APIs. Assets refers to user provided assets such as avatars and backgrounds, also website graphics like logos and homepage covers. - -Check [External storage](https://v4-admin.chevereto.com/features/external-storage.html) for adding external storage servers for user content uploads. - -| Variable | Example | -| ------------------------------------ | -------------- | -| CHEVERETO_ASSET_STORAGE_ACCOUNT_ID | 123 | -| CHEVERETO_ASSET_STORAGE_ACCOUNT_NAME | account_name | -| CHEVERETO_ASSET_STORAGE_BUCKET | bucket | -| CHEVERETO_ASSET_STORAGE_KEY | key | -| CHEVERETO_ASSET_STORAGE_NAME | assets | -| CHEVERETO_ASSET_STORAGE_REGION | us-west-2 | -| CHEVERETO_ASSET_STORAGE_SECRET | secret | -| CHEVERETO_ASSET_STORAGE_SERVER | server | -| CHEVERETO_ASSET_STORAGE_SERVICE | service | -| CHEVERETO_ASSET_STORAGE_TYPE | s3 | -| CHEVERETO_ASSET_STORAGE_URL | `/bucket` | +## System variables + +Environment variables for the system context. + +| Variable | Example | +| ------------------- | ------------------ | +| CHEVERETO_SERVICING | `server`, `docker` | ## Database variables @@ -37,11 +25,13 @@ Environment variables for the database details. ## Error logging variables -Environment variables for handling [errors](../reference/errors.md). +Environment variables for handling [error](../reference/errors.md) logging. -| Variable | Example | -| ------------------- | ---------------------------- | -| CHEVERETO_ERROR_LOG | /var/log/chevereto-error.log | +| Variable | Default | +| ------------------------ | -------------- | +| CHEVERETO_ERROR_LOG_CLI | `` | +| CHEVERETO_ERROR_LOG_CRON | `` | +| CHEVERETO_ERROR_LOG | `php://stderr` | ## Debug variables @@ -51,15 +41,23 @@ Environment variables for [debug](../../developer/how-to/debug.md). | --------------------- | ------- | | CHEVERETO_DEBUG_LEVEL | `1` | +## xrDebug variables + +| CHEVERETO_ENABLE_XRDEBUG | `0` | +| CHEVERETO_XRDEBUG_HOST | `localhost` | +| CHEVERETO_XRDEBUG_HTTPS | `0` | +| CHEVERETO_XRDEBUG_KEY | `` | +| CHEVERETO_XRDEBUG_PORT | 27420 | + ## Hostname variables Environment variables for the hostname configuration. -| Variable | Example | -| ----------------------- | ------------- | -| CHEVERETO_HOSTNAME | chevereto.loc | -| CHEVERETO_HOSTNAME_PATH | / | -| CHEVERETO_HTTPS | `true` | +| Variable | Example | +| ----------------------- | -------------------- | +| CHEVERETO_HOSTNAME | `chevereto.internal` | +| CHEVERETO_HOSTNAME_PATH | `/` | +| CHEVERETO_HTTPS | `true` | ## Encryption key @@ -73,10 +71,10 @@ Environment variables for the [encryption](../reference/encryption.md) functiona Environment variables for the session driver. -| Variable | Example | -| ------------------------------ | ------- | -| CHEVERETO_SESSION_SAVE_HANDLER | `files` | -| CHEVERETO_SESSION_SAVE_PATH | `/tmp` | +| Variable | Example | +| ------------------------------ | ---------------- | +| CHEVERETO_SESSION_SAVE_HANDLER | `files`, `redis` | +| CHEVERETO_SESSION_SAVE_PATH | `/tmp` | ## Image handling variables @@ -100,15 +98,53 @@ Environment variables for controlling binary tools used by Chevereto. Environment variables for the context where Chevereto system is being provided. Depending on where you run it, you may want to disable some Chevereto functionality. -| Variable | Default | -| ------------------------------- | ------- | -| CHEVERETO_ENABLE_BULK_IMPORTER | `1` | -| CHEVERETO_ENABLE_CHECK_UPDATES | `1` | -| CHEVERETO_ENABLE_HTACCESS_CHECK | `0` | -| CHEVERETO_ENABLE_LOCAL_STORAGE | `1` | -| CHEVERETO_ENABLE_PHP_PAGES | `0` | -| CHEVERETO_ENABLE_UPDATE_CLI | `1` | -| CHEVERETO_ENABLE_UPDATE_HTTP | `1` | +| Variable | Default | +| ---------------------------------------- | ------- | +| CHEVERETO_ENABLE_API_GUEST | `1` | +| CHEVERETO_ENABLE_BANNERS | `1` | +| CHEVERETO_ENABLE_BULK_IMPORTER | `1` | +| CHEVERETO_ENABLE_CAPTCHA | `1` | +| CHEVERETO_ENABLE_CDN | `1` | +| CHEVERETO_ENABLE_CONSENT_SCREEN | `1` | +| CHEVERETO_ENABLE_COOKIE_COMPLIANCE | `1` | +| CHEVERETO_ENABLE_DEBUG | `1` | +| CHEVERETO_ENABLE_EXPOSE_PAID_FEATURES | `1` | +| CHEVERETO_ENABLE_EXTERNAL_SERVICES | `1` | +| CHEVERETO_ENABLE_EXTERNAL_STORAGE | `1` | +| CHEVERETO_ENABLE_FAVICON | `1` | +| CHEVERETO_ENABLE_FOLLOWERS | `1` | +| CHEVERETO_ENABLE_FORCE_POWERED_BY_FOOTER | `0` | +| CHEVERETO_ENABLE_HTACCESS_CHECK | `0` | +| CHEVERETO_ENABLE_IP_BANS | `1` | +| CHEVERETO_ENABLE_LANGUAGE_CHOOSER | `1` | +| CHEVERETO_ENABLE_LIKES | `1` | +| CHEVERETO_ENABLE_LOCAL_STORAGE | `1` | +| CHEVERETO_ENABLE_LOGIN_PROVIDERS | `1` | +| CHEVERETO_ENABLE_LOGO_CUSTOM | `1` | +| CHEVERETO_ENABLE_MODERATION | `1` | +| CHEVERETO_ENABLE_NEWS_CHECK | `1` | +| CHEVERETO_ENABLE_NOTIFICATIONS | `1` | +| CHEVERETO_ENABLE_PAGES | `1` | +| CHEVERETO_ENABLE_PHP_PAGES | `0` | +| CHEVERETO_ENABLE_POWERED_BY_SETTING | `1` | +| CHEVERETO_ENABLE_PUP_CUSTOM_URL | `1` | +| CHEVERETO_ENABLE_ROUTING | `1` | +| CHEVERETO_ENABLE_SEO_ALBUM_URL | `1` | +| CHEVERETO_ENABLE_SEO_IMAGE_URL | `1` | +| CHEVERETO_ENABLE_SERVICE_AKISMET | `1` | +| CHEVERETO_ENABLE_SERVICE_MODERATECONTENT | `1` | +| CHEVERETO_ENABLE_SERVICE_PROJECTARACHNID | `1` | +| CHEVERETO_ENABLE_SERVICE_STOPFORUMSPAM | `1` | +| CHEVERETO_ENABLE_STOPWORDS | `1` | +| CHEVERETO_ENABLE_UPDATE_CHECK | `1` | +| CHEVERETO_ENABLE_UPDATE_CLI | `1` | +| CHEVERETO_ENABLE_UPDATE_HTTP | `1` | +| CHEVERETO_ENABLE_UPLOAD_FLOOD_PROTECTION | `1` | +| CHEVERETO_ENABLE_UPLOAD_PLUGIN | `1` | +| CHEVERETO_ENABLE_UPLOAD_URL | `1` | +| CHEVERETO_ENABLE_UPLOAD_WATERMARK | `1` | +| CHEVERETO_ENABLE_USERS | `1` | +| CHEVERETO_ENABLE_XRDEBUG | `0` | ## Limits @@ -116,12 +152,26 @@ Environment variables that limits the use for Chevereto Zero `0` means no limit. -| Variable | Example | -| ------------------------------ | ------- | -| CHEVERETO_MAX_ALBUMS | `0` | -| CHEVERETO_MAX_IMAGES | `0` | -| CHEVERETO_MAX_USER_ALBUMS_LIST | `300` | -| CHEVERETO_MAX_USERS | `0` | +| Variable | Example | +| ------------------------------------ | ------- | +| CHEVERETO_MAX_ADMINS | `0` | +| CHEVERETO_MAX_ALBUMS | `0` | +| CHEVERETO_MAX_CATEGORIES | `0` | +| CHEVERETO_MAX_EXECUTION_TIME_SECONDS | `30` | +| CHEVERETO_MAX_FILES | `0` | +| CHEVERETO_MAX_LOGIN_PROVIDERS | `0` | +| CHEVERETO_MAX_MANAGERS | `0` | +| CHEVERETO_MAX_MEMORY_SIZE | `512M` | +| CHEVERETO_MAX_PAGES | `0` | +| CHEVERETO_MAX_POST_SIZE | `100M` | +| CHEVERETO_MAX_STORAGES | `0` | +| CHEVERETO_MAX_TAGS_PER_FILE | `0` | +| CHEVERETO_MAX_TAGS_PER_LISTING | `0` | +| CHEVERETO_MAX_TAGS | `0` | +| CHEVERETO_MAX_UPLOAD_SIZE | `100M` | +| CHEVERETO_MAX_USER_ALBUMS_LIST | `500` | +| CHEVERETO_MAX_USERS | `0` | +| CHEVERETO_MIN_STORAGES_ACTIVE | `0` | * For `CHEVERETO_MAX_USER_ALBUMS_LIST` it affects the number of albums on user's dropdown album menus. diff --git a/application/reference/encryption.md b/application/reference/encryption.md index 0aea459..0de4a9d 100644 --- a/application/reference/encryption.md +++ b/application/reference/encryption.md @@ -25,9 +25,6 @@ The following settings are encrypted in the database: | [Akismet API key](https://v4-admin.chevereto.com/settings/external-services.html#akismet-api-key) | akismet_api_key | | [ModerateContent API Key](https://v4-admin.chevereto.com/settings/external-services.html#moderatecontent-api-key) | moderatecontent_key | | [Project Arachnid API Key](https://v4-admin.chevereto.com/settings/external-services.html#project-arachnid-api-key) | arachnid_key | -| [xrDebug Host](https://v4-admin.chevereto.com/settings/system.html#xr-debug-host) | xr_host | -| [xrDebug Port](https://v4-admin.chevereto.com/settings/system.html#xr-debug-port) | xr_port | -| xrDebug Key | xr_key | ### Storage credentials diff --git a/developer/how-to/debug.md b/developer/how-to/debug.md index ed27d6e..5a58dcf 100644 --- a/developer/how-to/debug.md +++ b/developer/how-to/debug.md @@ -16,14 +16,7 @@ To debug errors go to [Settings > System > Debug errors](https://v4-admin.chever cd app && vendor/bin/xrdebug ``` -* Enable xrDebug by configuring the `CHEVERETO_ENABLE_XRDEBUG` key. - -```php -'CHEVERETO_XRDEBUG_HOST' => 'localhost', -'CHEVERETO_XRDEBUG_HTTPS' => '0', -'CHEVERETO_XRDEBUG_KEY' => '', -'CHEVERETO_XRDEBUG_PORT' => '27420', -``` +* Enable xrDebug by configuring the `CHEVERETO_ENABLE_XRDEBUG` [key](../../application/configuration/environment.md#debug-variables). ## Debug with Docker @@ -41,9 +34,9 @@ Chevereto access log: docker logs CONTAINER -f 2>/dev/null ``` -## Debug with configuration +## Debug with logging -Debug can be [configured](../../application/configuration/configuring.md) using [environment variables](../../application/configuration/environment.md#debug-variables). +Debug can be [configured](../../application/configuration/configuring.md) using [environment variables](../../application/configuration/environment.md#debug-variables) to log to a file or device. ### Debug level