diff --git a/.env.demo b/.env.demo index 59f17f94..a98798ff 100644 --- a/.env.demo +++ b/.env.demo @@ -227,6 +227,7 @@ EMAIL_SENDER=DocuElevate System # These settings are intentionally separate from the shared EMAIL_* settings above. # Configuring EMAIL_HOST for password reset / notifications does NOT automatically # enable the email destination – you must set DEST_EMAIL_HOST to activate it. +# DEST_EMAIL_ENABLED=true # Set to false to disable email delivery without removing credentials DEST_EMAIL_HOST=smtp.example.com DEST_EMAIL_PORT=587 DEST_EMAIL_USERNAME=docuelevate@example.com @@ -313,6 +314,7 @@ IMAP_READONLY_MODE=false # **Storage/Document Services** # Amazon S3 +# S3_ENABLED=true # Set to false to disable S3 uploads without removing credentials AWS_REGION=us-east-1 AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY @@ -322,12 +324,14 @@ S3_STORAGE_CLASS=STANDARD S3_ACL=private # NextCloud +# NEXTCLOUD_ENABLED=true # Set to false to disable NextCloud uploads without removing credentials NEXTCLOUD_UPLOAD_URL=https://nextcloud.example.com/remote.php/dav/files/ NEXTCLOUD_FOLDER="" NEXTCLOUD_USERNAME= NEXTCLOUD_PASSWORD= # Paperless-ngx +# PAPERLESS_ENABLED=true # Set to false to disable Paperless uploads without removing credentials PAPERLESS_HOST=https://paperless.example.com PAPERLESS_NGX_API_TOKEN= # Optional: Name of the custom field in Paperless-ngx to store the "absender" (sender) value @@ -344,12 +348,14 @@ PAPERLESS_NGX_API_TOKEN= # PAPERLESS_CUSTOM_FIELDS_MAPPING= # Dropbox +# DROPBOX_ENABLED=true # Set to false to disable Dropbox uploads without removing credentials DROPBOX_APP_KEY= DROPBOX_APP_SECRET= DROPBOX_REFRESH_TOKEN= DROPBOX_FOLDER="/Documents/Uploads" # Google Drive +# GOOGLE_DRIVE_ENABLED=true # Set to false to disable Google Drive uploads without removing credentials # Service Account Method: GOOGLE_DRIVE_CREDENTIALS_JSON={"type":"service_account","project_id":"your-project","private_key_id":"key-id","private_key":"-----BEGIN PRIVATE KEY-----\nYOUR_PRIVATE_KEY\n-----END PRIVATE KEY-----\n","client_email":"service-account@project.iam.gserviceaccount.com","client_id":"client-id","auth_uri":"https://accounts.google.com/o/oauth2/auth","token_uri":"https://oauth2.googleapis.com/token","auth_provider_x509_cert_url":"https://www.googleapis.com/oauth2/v1/certs","client_x509_cert_url":"https://www.googleapis.com/robot/v1/metadata/x509/service-account%40project.iam.gserviceaccount.com"} GOOGLE_DRIVE_FOLDER_ID= @@ -362,6 +368,7 @@ GOOGLE_DRIVE_CLIENT_SECRET=your-oauth-client-secret # Required for OAuth method GOOGLE_DRIVE_REFRESH_TOKEN=your-oauth-refresh-token # Required for OAuth method # OneDrive +# ONEDRIVE_ENABLED=true # Set to false to disable OneDrive uploads without removing credentials ONEDRIVE_CLIENT_ID=your-client-id ONEDRIVE_CLIENT_SECRET=your-client-secret ONEDRIVE_TENANT_ID=common @@ -369,6 +376,7 @@ ONEDRIVE_REFRESH_TOKEN=your-refresh-token ONEDRIVE_FOLDER_PATH=Documents/Uploads # WebDAV +# WEBDAV_ENABLED=true # Set to false to disable WebDAV uploads without removing credentials WEBDAV_URL=https://webdav.example.com/path WEBDAV_USERNAME=webdav_user WEBDAV_PASSWORD=your_secure_webdav_password @@ -376,6 +384,7 @@ WEBDAV_FOLDER=/Documents/Uploads WEBDAV_VERIFY_SSL=True # FTP +# FTP_ENABLED=true # Set to false to disable FTP uploads without removing credentials # Security Note: FTP_USE_TLS=True is strongly recommended for secure connections # Set FTP_ALLOW_PLAINTEXT=False in production to prevent unencrypted FTP FTP_HOST=ftp.example.com @@ -387,6 +396,7 @@ FTP_USE_TLS=True FTP_ALLOW_PLAINTEXT=True # SFTP +# SFTP_ENABLED=true # Set to false to disable SFTP uploads without removing credentials # Security Note: Host key verification is enabled by default (False) # Only set to True in development/testing environments if needed # When false, configure SSH known_hosts for proper host key verification @@ -400,6 +410,7 @@ SFTP_FOLDER=/Documents/Uploads SFTP_DISABLE_HOST_KEY_VERIFICATION=False # Default is False (secure); set to True only for testing # iCloud Drive +# ICLOUD_ENABLED=true # Set to false to disable iCloud uploads without removing credentials # Requires an Apple ID with iCloud Drive enabled. # For accounts with two-factor authentication (most accounts), generate an # app-specific password at https://appleid.apple.com/account/manage diff --git a/docs/ConfigurationGuide.md b/docs/ConfigurationGuide.md index 398aed82..a70c8154 100644 --- a/docs/ConfigurationGuide.md +++ b/docs/ConfigurationGuide.md @@ -943,6 +943,7 @@ TESSERACT_LANGUAGE=eng+deu | **Variable** | **Description** | |-------------------------------------|-----------------------------------------------------------------------------------------------------| +| `PAPERLESS_ENABLED` | Set to `false` to disable Paperless-ngx uploads without removing credentials. Default: `true` | | `PAPERLESS_NGX_API_TOKEN` | API token for Paperless NGX. | | `PAPERLESS_HOST` | Root URL for Paperless NGX (e.g. `https://paperless.example.com`). | | `PAPERLESS_CUSTOM_FIELD_ABSENDER` | (Optional, Legacy) Name of the custom field in Paperless-ngx to store the sender ("absender") information. If set, the extracted sender will be automatically set as a custom field after document upload. Example: `Absender` or `Sender` | @@ -985,6 +986,7 @@ PAPERLESS_CUSTOM_FIELDS_MAPPING='{"absender": "Sender", "empfaenger": "Recipient | **Variable** | **Description** | |-------------------------|--------------------------------------------------| +| `DROPBOX_ENABLED` | Set to `false` to disable Dropbox uploads without removing credentials. Default: `true` | | `DROPBOX_APP_KEY` | Dropbox API app key. | | `DROPBOX_APP_SECRET` | Dropbox API app secret. | | `DROPBOX_REFRESH_TOKEN` | OAuth2 refresh token for Dropbox. | @@ -996,6 +998,7 @@ For detailed setup instructions, see the [Dropbox Setup Guide](DropboxSetup.md). | **Variable** | **Description** | |-------------------------|---------------------------------------------------------------| +| `NEXTCLOUD_ENABLED` | Set to `false` to disable Nextcloud uploads without removing credentials. Default: `true` | | `NEXTCLOUD_UPLOAD_URL` | Nextcloud WebDAV URL (e.g. `https://nc.example.com/remote.php/dav/files/`). | | `NEXTCLOUD_USERNAME` | Nextcloud login username. | | `NEXTCLOUD_PASSWORD` | Nextcloud login password. | @@ -1005,6 +1008,7 @@ For detailed setup instructions, see the [Dropbox Setup Guide](DropboxSetup.md). | **Variable** | **Description** | |---------------------------------|-------------------------------------------------------| +| `GOOGLE_DRIVE_ENABLED` | Set to `false` to disable Google Drive uploads without removing credentials. Default: `true` | | `GOOGLE_DRIVE_USE_OAUTH` | Set to `true` to use OAuth flow (recommended) | | `GOOGLE_DRIVE_CLIENT_ID` | OAuth Client ID (required if using OAuth flow) | | `GOOGLE_DRIVE_CLIENT_SECRET` | OAuth Client Secret (required if using OAuth flow) | @@ -1021,6 +1025,7 @@ For detailed setup instructions, see the [Google Drive Setup Guide](GoogleDriveS | **Variable** | **Description** | |-------------------------|---------------------------------------------------------------| +| `WEBDAV_ENABLED` | Set to `false` to disable WebDAV uploads without removing credentials. Default: `true` | | `WEBDAV_URL` | WebDAV server URL (e.g. `https://webdav.example.com/path`). | | `WEBDAV_USERNAME` | WebDAV authentication username. | | `WEBDAV_PASSWORD` | WebDAV authentication password. | @@ -1031,6 +1036,7 @@ For detailed setup instructions, see the [Google Drive Setup Guide](GoogleDriveS | **Variable** | **Description** | |-------------------------|---------------------------------------------------------------| +| `FTP_ENABLED` | Set to `false` to disable FTP uploads without removing credentials. Default: `true` | | `FTP_HOST` | FTP server hostname or IP address. | | `FTP_PORT` | FTP port (default: `21`). | | `FTP_USERNAME` | FTP authentication username. | @@ -1043,6 +1049,7 @@ For detailed setup instructions, see the [Google Drive Setup Guide](GoogleDriveS | **Variable** | **Description** | |------------------------------|-------------------------------------------------------| +| `SFTP_ENABLED` | Set to `false` to disable SFTP uploads without removing credentials. Default: `true` | | `SFTP_HOST` | SFTP server hostname or IP address. | | `SFTP_PORT` | SFTP port (default: `22`). | | `SFTP_USERNAME` | SFTP authentication username. | @@ -1074,6 +1081,7 @@ For detailed setup instructions, see the [Google Drive Setup Guide](GoogleDriveS | **Variable** | **Description** | |----------------------------------|---------------------------------------------------------------------| +| `DEST_EMAIL_ENABLED` | Set to `false` to disable email delivery without removing credentials. Default: `true` | | `DEST_EMAIL_HOST` | SMTP server hostname for document delivery. | | `DEST_EMAIL_PORT` | SMTP port for document delivery (default: `587`). | | `DEST_EMAIL_USERNAME` | SMTP authentication username for document delivery. | @@ -1086,6 +1094,7 @@ For detailed setup instructions, see the [Google Drive Setup Guide](GoogleDriveS | **Variable** | **Description** | |---------------------------------|-------------------------------------------------------| +| `ONEDRIVE_ENABLED` | Set to `false` to disable OneDrive uploads without removing credentials. Default: `true` | | `ONEDRIVE_CLIENT_ID` | Azure AD application client ID | | `ONEDRIVE_CLIENT_SECRET` | Azure AD application client secret | | `ONEDRIVE_TENANT_ID` | Azure AD tenant ID: use "common" for personal accounts or your tenant ID for corporate accounts | @@ -1098,6 +1107,7 @@ For detailed setup instructions, see the [OneDrive Setup Guide](OneDriveSetup.md | **Variable** | **Description** | |---------------------------------|-------------------------------------------------------| +| `S3_ENABLED` | Set to `false` to disable S3 uploads without removing credentials. Default: `true` | | `AWS_ACCESS_KEY_ID` | AWS IAM access key ID | | `AWS_SECRET_ACCESS_KEY` | AWS IAM secret access key | | `AWS_REGION` | AWS region where your S3 bucket is located (default: `us-east-1`) | @@ -1112,6 +1122,7 @@ For detailed setup instructions, see the [Amazon S3 Setup Guide](AmazonS3Setup.m | **Variable** | **Description** | |---------------------------------|-------------------------------------------------------| +| `ICLOUD_ENABLED` | Set to `false` to disable iCloud uploads without removing credentials. Default: `true` | | `ICLOUD_USERNAME` | Apple ID email address | | `ICLOUD_PASSWORD` | App-specific password (generate at [appleid.apple.com](https://appleid.apple.com/account/manage)) | | `ICLOUD_FOLDER` | Target folder path in iCloud Drive (e.g. `Documents/Uploads`) |