Skip to content

Commit 68f5758

Browse files
committed
Update README.md
1 parent 6d302cc commit 68f5758

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,24 @@ helm install my-release ncsa/clowder -f values.yaml
9292

9393
> **Tip**: You can use the default [values.yaml](values.yaml)
9494
95+
## Users
96+
97+
To be able to work with clowder you will need an account on the server. Clowder will not ship with any accounts and will
98+
require users to be approved by an admin. The list of initial admins is set using `initialAdmins`. Any user that creates
99+
an account with an email specified in this list will automatically be approved.
100+
101+
## Emails
102+
103+
Clowder will use emails when users sign up. To enable emails you need to configure the email server. To setup emails use
104+
105+
```yaml
106+
smtp:
107+
mock: false
108+
host: smtp.example.com
109+
```
110+
111+
If this is not set, the clowder server will use a mock and print the emails in the clowder logs.
112+
95113
## Helpmenu
96114
97115
You can add additional entries to the help menu, each entry in the list needs to have a label and a URL, for example

0 commit comments

Comments
 (0)