diff --git a/.vscode/launch.json b/.vscode/launch.json index 94312a3e14..405778b585 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -19,6 +19,9 @@ "PROXY_ENABLE_BASIC_AUTH": "true", // set insecure options because we don't have valid certificates in dev environments "OCIS_INSECURE": "true", + // demo users + "ACCOUNTS_DEMO_USERS_AND_GROUPS": "true", + "IDM_CREATE_DEMO_USERS": "true" // OCIS_RUN_EXTENSIONS allows to start a subset of extensions even in the supervised mode //"OCIS_RUN_EXTENSIONS": "settings,storage-metadata,glauth,graph,graph-explorer,idp,ocs,store,thumbnails,web,webdav,storage-frontend,storage-gateway,storage-userprovider,storage-groupprovider,storage-authbasic,storage-authbearer,storage-authmachine,storage-users,storage-shares,storage-public-link,storage-appprovider,storage-sharing,accounts,proxy", } diff --git a/docs/ocis/deployment/_index.md b/docs/ocis/deployment/_index.md index 29e8bb2517..d2db1b8eb9 100644 --- a/docs/ocis/deployment/_index.md +++ b/docs/ocis/deployment/_index.md @@ -50,8 +50,7 @@ You can change it by setting the `OCIS_MACHINE_AUTH_API_KEY` environment variabl {{< 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. +By default, oCIS doesn't create any demo users. During the first startup, it 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/_index.md b/docs/ocis/getting-started/_index.md index 84904501c6..534d7bde05 100644 --- a/docs/ocis/getting-started/_index.md +++ b/docs/ocis/getting-started/_index.md @@ -42,8 +42,8 @@ curl https://download.owncloud.com/ocis/ocis/stable/1.19.1/ocis-1.19.1-linux-amd # make binary executable chmod +x ocis -# run -OCIS_INSECURE=true ./ocis server +# run with demo users +OCIS_INSECURE=true ACCOUNTS_DEMO_USERS_AND_GROUPS=true ./ocis server ``` The default primary storage location is `~/.ocis` or `/var/lib/ocis` depending on the packaging format and your operating system user. You can change that value by configuration. @@ -64,13 +64,17 @@ The `latest` tag always reflects the current master branch. ```console docker pull owncloud/ocis -docker run --rm -ti -p 9200:9200 -e OCIS_INSECURE=true owncloud/ocis +docker run --rm -ti -p 9200:9200 -e OCIS_INSECURE=true -e ACCOUNTS_DEMO_USERS_AND_GROUPS=true owncloud/ocis ``` {{< hint info >}} When you're using oCIS with self-signed certificates, you need to set the environment variable `OCIS_INSECURE=true`, in order to make oCIS work. {{< /hint >}} +{{< hint warming >}} +When you're creating the [demo users]({{< ref "./demo-users" >}}) by setting `ACCOUNTS_DEMO_USERS_AND_GROUPS=true`, you need to be sure that this instance is not used in prodution because the passwords are public. +{{< /hint >}} + {{< hint warning >}} In order to persist your data, you need to mount a docker volume or create a host bind-mount at `/var/lib/ocis`, for example with: `-v /some/host/dir:/var/lib/ocis` diff --git a/docs/ocis/getting-started/demo-users.md b/docs/ocis/getting-started/demo-users.md index d5a5373a83..1865446d93 100644 --- a/docs/ocis/getting-started/demo-users.md +++ b/docs/ocis/getting-started/demo-users.md @@ -7,11 +7,11 @@ geekdocEditPath: edit/master/docs/ocis/getting-started 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. +oCIS has the option to create demo users during the first startup. 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. +To create the demo users, run the inital setup step with an additional environment variable. +`ACCOUNTS_DEMO_USERS_AND_GROUPS=true ./bin/ocis server` will generate the demo users listed in the table below. By default, it only generates the admin and one user for IDP and Reva respectively. {{< /hint >}} Following users are available in the demo set: