Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs-only] Document skip step for demo users/groups and fix changelog #2519

Merged
merged 1 commit into from
Sep 17, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions changelog/unreleased/optional-skip-demo-users-creation.md
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion changelog/unreleased/remove-notifications-placeholder.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
6 changes: 0 additions & 6 deletions changelog/unreleased/skip-demo-users.md

This file was deleted.

3 changes: 3 additions & 0 deletions docs/ocis/deployment/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
5 changes: 5 additions & 0 deletions docs/ocis/getting-started/demo-users.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down