Merge pull request #2519 from owncloud/17092021_document-skip-user-op…

…tion [docs-only] Document skip step for demo users/groups and fix changelog
owncloud · Sep 17, 2021 · 1f6d1f3 · 1f6d1f3
2 parents d866e9c + e437ce2
commit 1f6d1f3
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 7 deletions.
diff --git a/changelog/unreleased/optional-skip-demo-users-creation.md b/changelog/unreleased/optional-skip-demo-users-creation.md
@@ -0,0 +1,8 @@
+Enhancement: Add option to skip generation of demo users and groups
+
+We've added a new environment variable to decide whether we should generate the demo users and groups or not. 
+This environment variable is set to `true` by default, so the demo users and groups will get generated by default as long as oCIS is in its "technical preview" stage.
+
+In any case, there are still some users and groups automatically generated: for users: Reva IOP, Kopano IDP, admin; for groups: sysusers and users.
+
+https://github.com/owncloud/ocis/pull/2495
diff --git a/changelog/unreleased/remove-notifications-placeholder.md b/changelog/unreleased/remove-notifications-placeholder.md
@@ -1,6 +1,6 @@
 Bugfix: Remove notifications placeholder
 
-Since Reva was communicating its notification capabilities incorrectly, oCIS relied on a hardcoding string to overwrite them.
+Since Reva was communicating its notification capabilities incorrectly, oCIS relied on a hardcoded string to overwrite them.
 This has been fixed in [reva#1819](https://github.com/cs3org/reva/pull/1819) so we now removed the hardcoded string 
 and don't modify Reva's notification capabilities anymore in order to fix clients having to poll a (non-existent) notifications endpoint.
 

diff --git a/changelog/unreleased/skip-demo-users.md b/changelog/unreleased/skip-demo-users.md
diff --git a/docs/ocis/deployment/_index.md b/docs/ocis/deployment/_index.md
@@ -45,6 +45,9 @@ You can change it by setting the `STORAGE_TRANSFER_SECRET` environment variable
 
 {{< hint info >}}
 Before deleting the demo users mentioned below, you must create a new account for yourself and assign it to the administrator role.
+
+To skip the generation of demo users in the first place, run the inital setup step with an additional environment variable.
+`ACCOUNTS_DEMO_USERS_AND_GROUPS=false ./bin/ocis server` generates only the admin, and one user for IDP and Reva respectively.
 {{< /hint >}}
 
 oCIS ships with a few demo users besides the system users:

diff --git a/docs/ocis/getting-started/demo-users.md b/docs/ocis/getting-started/demo-users.md
@@ -9,6 +9,11 @@ geekdocFilePath: demo-users.md
 
 As long as oCIS is released as [technology preview]({{< ref "../release_roadmap#release_roadmap" >}}) it will come with default demo users. These enable you to do quick testing and developing.
 
+{{< hint info >}}
+To skip the generation of demo users, run the inital setup step with an additional environment variable.
+`ACCOUNTS_DEMO_USERS_AND_GROUPS=false ./bin/ocis server` generates only the admin, and one user for IDP and Reva respectively.
+{{< /hint >}}
+
 Following users are available in the demo set:
 
 | username | password      | email                | role  | groups                                                                  |