aaron/nextcloud-docker
0
0
Fork 0
mirror of https://github.com/nextcloud/docker.git synced 2025-03-15 19:05:09 +01:00
Code Activity

Update README.md

Browse source 
Signed-off-by: Josh <josh.t.richards@gmail.com>
This commit is contained in:
Josh 2024-05-29 18:03:44 -04:00 • committed by GitHub
parent c45a9f4194
commit 5366de2a84
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 39 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

52
README.md
View file

@ -122,20 +122,37 @@ In addition, support for adjusting several other key aspects of Nextcloud and th
Keep in mind the intention is to auto configure initial installation. Only a few variables may be used after initial deployment (i.e. changing them in your Compose file may not flow through to an existing installation). Keep in mind the intention is to auto configure initial installation. Only a few variables may be used after initial deployment (i.e. changing them in your Compose file may not flow through to an existing installation).
All variables below, at a minimum, work at installation time. Some may be used after installation time. Specific contraints are noted in the table below. Details about each variable follow the table. All variables below, at a minimum, work at installation time. Some may be used after installation time and thus may override `config.php` and similar parameters. Specifics are noted in the tables below. Details about each variable follow the table.
| Variable | Default | After install? | Dependencies? | Visible in `config.php`? | Visible via `occ config:list`? | Overrides `config.php`? | Can be secret? | Rootless? | Injected via | * Usage
| ----------------------------- | ------------------ | ------------------- | ---------------------------------- | ------------------------ | -------------------------------| ------------------------ | -------------- | --------- | ---------------------------------------- | - Install
| SQLITE_DATABASE | | No | No | Yes | Yes | n/a | n/a | Yes | `entrypoint.sh` or `autoconfig.php` | - Post-install
| MYSQL_DATABASE | | No | All MYSQL_* variables | Yes | Yes | n/a | n/a | Yes | `entrypoint.sh` or `autoconfig.php` | * Dependencies
| MYSQL_USER | | No | All MYSQL_* variables | Yes | Yes | n/a | Yes | Yes | `entrypoint.sh` or `autoconfig.php` | * Visibility
| MYSQL_PASSWORD | | No | All MYSQL_* variables | Yes | Yes | n/a | Yes | Yes | `entrypoint.sh` or `autoconfig.php` | - `config.php`
| MYSQL_HOST | | No | All MYSQL_* variables | Yes | Yes | n/a | No | Yes | `entrypoint.sh` or `autoconfig.php` | - `occ config:list`
| POSTGRES_DB | | No | All POSTGRES_* variables | Yes | Yes | n/a | n/a | Yes | `entrypoint.sh` or `autoconfig.php` | * Priority
| POSTGRES_USER - Overrides `config.php`
| POSTGRES_PASSWORD * Secret?
| POSTGRES_HOST * Compatibility
| NEXTCLOUD_ADMIN_USER - Rootless
* Injection method(s)
- `entrypoint.sh` to Server installer
- `autoconfig.php` to Server installer
| Environment Variable | Description | Example | Secret[4] | Post-install[5] | Visibility | Notes | Method |
| :------------------: | :---------: | :-----: | :-----: | :-------------: | :--------: | ----- | ------ |
| SQLITE_DATABASE | Use SQLite as the database and use as the `dbname` | `ncdb` | No | No | `config.php` | Suitable to testing and minimal-instances only | Injected via `entrypoint.sh` to `occ maintenance:install` (when specified with `NEXTCLOUD_*`) otherwise via `autoconfig.php` |
| MYSQL_DATABASE | Use MySQL/MariaDB as the database and use as the `dbname` | `ncdb` | ✓ | No | `config.php` | Ignored unless all `MYSQL_*` variables are specified | Injected via `entrypoint.sh` to `occ maintenance:install` (when specified with `NEXTCLOUD_*`) otherwise via `autoconfig.php` |
| MYSQL_USER | the `dbuser` | `ncdbuser` | ✓ | No | `config.php` | See `MYSQL_DATABASE` | |
| MYSQL_PASSWORD | the `dbpass` | `ncdbpass` | ✓ | No | `config.php` | See `MYSQL_DATABASE` | |
| MYSQL_HOST | the `dbhost` | `db` or `localhost:/usr/local/run/mysql.sock` | ✓ | No | `config.php` | See `MYSQL_DATABASE` | |
| POSTGRES_DB | Use PostgreSQL as the database and use as the `dbname` | `ncdb` | ✓ | No | `config.php` | Ignored unless all `POSTGRES_*` variables are specified | Injected via `entrypoint.sh` to `occ maintenance:install` (when specified with `NEXTCLOUD_*`) otherwise via `autoconfig.php` |
| POSTGRES_USER | the `dbuser` | `ncdbuser` | ✓ | No | `config.php` | See `POSTGRES_DB` | |
| POSTGRES_PASSWORD | the `dbpass` | `ncdbpass` | ✓ | No | `config.php` | See `POSTGRES_DB` | |
| POSTGRES_HOST | the `dbhost` | `db` | ✓ | No | `config.php` | See `POSTGRES_DB` | |
| NEXTCLOUD_ADMIN_USER | the initial Nextcloud admin user | `ncadmin` | ✓ | No | Nextcloud Super `admin` group | Ignored unless `NEXTCLOUD_ADMIN_PASSWORD` + preferred database variables are specified | Injected via `entrypoint.sh` to `occ maintenance:install` |
| NEXTCLOUD_ADMIN_PASSWORD | NEXTCLOUD_ADMIN_PASSWORD
| NEXTCLOUD_DATA_DIR | NEXTCLOUD_DATA_DIR
| NEXTCLOUD_TRUSTED_DOMAINS | NEXTCLOUD_TRUSTED_DOMAINS
@ -152,6 +169,15 @@ All variables below, at a minimum, work at installation time. Some may be used a
| APACHE_DISABLE_REWRITE_IP | APACHE_DISABLE_REWRITE_IP
| OVERWRITE* | OVERWRITE*
[4] Can be specified as a Docker secret or pulled from a file available from within the container. See [#docker-secrets](Docker Secrets).
[5] No = Installation only (i.e. cannot be modified post-installation via variable).
---
Set your database connection via auto configuration using the following environment variables. You must specify all of the environment variables for a given database or the database environment variables defaults to SQLITE. ONLY use one database type! Set your database connection via auto configuration using the following environment variables. You must specify all of the environment variables for a given database or the database environment variables defaults to SQLITE. ONLY use one database type!
__SQLite__: __SQLite__: