Skip to content

Commit 930f5d5

Browse files
authored
📝 Add Enabling Open User Registration to backend docs (fastapi#1191)
1 parent 13a5fdd commit 930f5d5

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

backend/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,16 @@ Make sure your editor is using the correct Python virtual environment.
6363

6464
Modify or add SQLModel models for data and SQL tables in `./backend/app/models.py`, API endpoints in `./backend/app/api/`, CRUD (Create, Read, Update, Delete) utils in `./backend/app/crud.py`.
6565

66+
### Enabling Open User Registration
67+
68+
By default the backend has user registration disabled, but there's already a route to register users. If you want to allow users to register themselves, you can set the environment variable `USERS_OPEN_REGISTRATION` to `True` in the `.env` file.
69+
70+
After modifying the environment variables, restart the Docker containers to apply the changes. You can do this by running:
71+
72+
```console
73+
$ docker compose up -d
74+
```
75+
6676
### VS Code
6777

6878
There are already configurations in place to run the backend through the VS Code debugger, so that you can use breakpoints, pause and explore variables, etc.

0 commit comments

Comments
 (0)