Skip to content

Commit 32cce47

Browse files
committed
use --env instead of -e
Signed-off-by: Simon L. <szaimen@e.mail.de>
1 parent ce1a852 commit 32cce47

1 file changed

Lines changed: 52 additions & 52 deletions

File tree

readme.md

Lines changed: 52 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Run the container:
1919
On Linux and macOS:
2020
```
2121
docker run -it \
22-
-e SERVER_BRANCH=master \
22+
--env SERVER_BRANCH=master \
2323
--name nextcloud-easy-test \
2424
-p 127.0.0.1:8443:443 \
2525
--volume="nextcloud_easy_test_npm_cache_volume:/var/www/.npm" \
@@ -31,7 +31,7 @@ ghcr.io/szaimen/nextcloud-easy-test:latest
3131
3232
```
3333
docker run -it ^
34-
-e SERVER_BRANCH=master ^
34+
--env SERVER_BRANCH=master ^
3535
--name nextcloud-easy-test ^
3636
-p 127.0.0.1:8443:443 ^
3737
--volume="nextcloud_easy_test_npm_cache_volume:/var/www/.npm" ^
@@ -46,7 +46,7 @@ ghcr.io/szaimen/nextcloud-easy-test:latest
4646
`docker run -it`
4747
This command creates a new docker container.
4848
49-
`-e SERVER_BRANCH=master`
49+
`--env SERVER_BRANCH=master`
5050
This inserts the environment variable `SERVER_BRANCH` into the container and sets it to the value `master`.
5151
5252
`--name nextcloud-easy-test`
@@ -76,7 +76,7 @@ docker rm nextcloud-easy-test
7676
```
7777
7878
### Running in a VM
79-
If you want to run this in a VM, you need to change the port in the initial command from `-p 127.0.0.1:8443:443` to `-p 8443:443` and add the following flag: `-e TRUSTED_DOMAIN=ip.of.the.VM` in order to automatically make it work.
79+
If you want to run this in a VM, you need to change the port in the initial command from `-p 127.0.0.1:8443:443` to `-p 8443:443` and add the following flag: `--env TRUSTED_DOMAIN=ip.of.the.VM` in order to automatically make it work.
8080
8181
### Available APPS
8282
Additionally, the container currently reacts on the following apps variables and installs and compiles those automatically if provided:
@@ -132,63 +132,63 @@ ZIPPER_BRANCH
132132
<summary>For easy copy and paste</summary>
133133
134134
```
135-
-e ACTIVITY_BRANCH=master \
136-
-e ANNOUNCEMENTS_BRANCH=master \
137-
-e APPROVAL_BRANCH=main \
138-
-e BOOKMARKS_BRANCH=master \
139-
-e BRUTEFORCESETTINGS_BRANCH=master \
140-
-e CALENDAR_BRANCH=main \
141-
-e CIRCLES_BRANCH=master \
142-
-e CONTACTS_BRANCH=main \
143-
-e DECK_BRANCH=main \
144-
-e DOWNLOADLIMIT_BRANCH=master \
145-
-e E2EE_BRANCH=master \
146-
-e FILES_LOCK_BRANCH=main \
147-
-e FIRSTRUNWIZARD_BRANCH=master \
148-
-e FORMS_BRANCH=main \
149-
-e GROUPFOLDERS_BRANCH=master \
150-
-e GUESTS_BRANCH=master \
151-
-e IMPERSONATE_BRANCH=master \
152-
-e INTEGRATIONGITHUB_BRANCH=main \
153-
-e ISSUTEMPLATE_BRANCH=master \
154-
-e LOGREADER_BRANCH=master \
155-
-e MAIL_BRANCH=main \
156-
-e MAPS_BRANCH=master \
157-
-e NEWS_BRANCH=master \
158-
-e NOTES_BRANCH=main \
159-
-e NOTIFICATIONS_BRANCH=master \
160-
-e OCS_API_VIEWER_BRANCH=main \
161-
-e PASSWORDPOLICY_BRANCH=master \
162-
-e PDFVIEWER_BRANCH=master \
163-
-e PHOTOS_BRANCH=master \
164-
-e POLLS_BRANCH=master \
165-
-e PRIVACY_BRANCH=master \
166-
-e RECOMMENDATIONS_BRANCH=master \
167-
-e RELATEDRESOURCES_BRANCH=master \
168-
-e RIGHTCLICK_BRANCH=master \
169-
-e SERVERINFO_BRANCH=master \
170-
-e SURVEYCLIENT_BRANCH=master \
171-
-e SUSPICIOUSLOGIN_BRANCH=master \
172-
-e TABLES_BRANCH=main \
173-
-e TALK_BRANCH=main \
174-
-e TASKS_BRANCH=master \
175-
-e TEXT_BRANCH=main \
176-
-e TWOFACTORWEBAUTHN_BRANCH=main \
177-
-e TWOFACTORTOTP_BRANCH=master \
178-
-e VIEWER_BRANCH=master \
179-
-e ZIPPER_BRANCH=main \
135+
--env ACTIVITY_BRANCH=master \
136+
--env ANNOUNCEMENTS_BRANCH=master \
137+
--env APPROVAL_BRANCH=main \
138+
--env BOOKMARKS_BRANCH=master \
139+
--env BRUTEFORCESETTINGS_BRANCH=master \
140+
--env CALENDAR_BRANCH=main \
141+
--env CIRCLES_BRANCH=master \
142+
--env CONTACTS_BRANCH=main \
143+
--env DECK_BRANCH=main \
144+
--env DOWNLOADLIMIT_BRANCH=master \
145+
--env E2EE_BRANCH=master \
146+
--env FILES_LOCK_BRANCH=main \
147+
--env FIRSTRUNWIZARD_BRANCH=master \
148+
--env FORMS_BRANCH=main \
149+
--env GROUPFOLDERS_BRANCH=master \
150+
--env GUESTS_BRANCH=master \
151+
--env IMPERSONATE_BRANCH=master \
152+
--env INTEGRATIONGITHUB_BRANCH=main \
153+
--env ISSUTEMPLATE_BRANCH=master \
154+
--env LOGREADER_BRANCH=master \
155+
--env MAIL_BRANCH=main \
156+
--env MAPS_BRANCH=master \
157+
--env NEWS_BRANCH=master \
158+
--env NOTES_BRANCH=main \
159+
--env NOTIFICATIONS_BRANCH=master \
160+
--env OCS_API_VIEWER_BRANCH=main \
161+
--env PASSWORDPOLICY_BRANCH=master \
162+
--env PDFVIEWER_BRANCH=master \
163+
--env PHOTOS_BRANCH=master \
164+
--env POLLS_BRANCH=master \
165+
--env PRIVACY_BRANCH=master \
166+
--env RECOMMENDATIONS_BRANCH=master \
167+
--env RELATEDRESOURCES_BRANCH=master \
168+
--env RIGHTCLICK_BRANCH=master \
169+
--env SERVERINFO_BRANCH=master \
170+
--env SURVEYCLIENT_BRANCH=master \
171+
--env SUSPICIOUSLOGIN_BRANCH=master \
172+
--env TABLES_BRANCH=main \
173+
--env TALK_BRANCH=main \
174+
--env TASKS_BRANCH=master \
175+
--env TEXT_BRANCH=main \
176+
--env TWOFACTORWEBAUTHN_BRANCH=main \
177+
--env TWOFACTORTOTP_BRANCH=master \
178+
--env VIEWER_BRANCH=master \
179+
--env ZIPPER_BRANCH=main \
180180
```
181181
182182
</details>
183183
184-
If one of the above variables are set via e.g. `-e CALENDAR_BRANCH=main` during the initial container creation, then will the container automatically get the chosen branch from github and compile and enable the chosen apps on the instance during the startup.
184+
If one of the above variables are set via e.g. `--env CALENDAR_BRANCH=main` during the initial container creation, then will the container automatically get the chosen branch from github and compile and enable the chosen apps on the instance during the startup.
185185
186-
Branches from custom forks can be installed as well. Use `-e CALENDAR_BRANCH=user:main` to install the `main` branch from the fork of `user`. If the fork has a different name (e.g. nextcloud-calendar), you can use the extended format `-e CALENDAR_BRANCH=user:main@nextcloud-calendar` to pull the branch `main` of the repo `user/nextcloud-calendar`. This format can be used with all app branch variables including `SERVER_BRANCH` and `NEXTCLOUDVUE_BRANCH`.
186+
Branches from custom forks can be installed as well. Use `--env CALENDAR_BRANCH=user:main` to install the `main` branch from the fork of `user`. If the fork has a different name (e.g. nextcloud-calendar), you can use the extended format `--env CALENDAR_BRANCH=user:main@nextcloud-calendar` to pull the branch `main` of the repo `user/nextcloud-calendar`. This format can be used with all app branch variables including `SERVER_BRANCH` and `NEXTCLOUDVUE_BRANCH`.
187187
188188
### Other variables
189189
- `MANUAL_INSTALL` if the variable is set, it will skip all apps variables and only clone the given server branch and start Apache directly. You will then be able to provide your own credentials and install recommended apps.
190190
- `SKELETON_ARCHIVE_URL` if the variable is set it will try to download a tar.gz file from a remote server, will untar it and will try to use that as a skeletondir which will make them the default files for new users ony the test instance.
191-
- `COMPILE_SERVER` if the variable is set (so e.g. via `-e COMPILE_SERVER=1`) it will compile javascript files for the chosen server branch. This only works for branches starting from version 24.0.0.
191+
- `COMPILE_SERVER` if the variable is set (so e.g. via `--env COMPILE_SERVER=1`) it will compile javascript files for the chosen server branch. This only works for branches starting from version 24.0.0.
192192
- `FULL_INSTANCE_BRANCH` if the variable is set it will download and install all apps that are bundled by default with a default Nextcloud instance. Set it for example to `stable28`. (**Please note**: Only stable branches are supported and not master or main. Also the support app and the suspicious_login app are never included. Additionally, any js compiling will be skipped if this variable is set).
193193
- `APACHE_PORT` if the variable is set, it will instead of the default port 443 inside the container, use the chosen Port for APACHE.
194194
- `NEXTCLOUDVUE_BRANCH` if the variable is set it will compile javascript files for the chosen nextcloud vue branch and automatically link all chosen apps that use nextcloud vue and additionally the server if COMPILE_SERVER is set.

0 commit comments

Comments
 (0)