You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/installation.qmd
+20-1Lines changed: 20 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -20,6 +20,8 @@ If you use VSCode with Docker to develop in a container, the following VSCode De
20
20
21
21
Simply create a `.devcontainer` folder in the root of the project and add a `devcontainer.json` file in the folder with the above content. VSCode may prompt you to install the Dev Container extension if you haven't already, and/or to open the project in a container. If not, you can manually select "Dev Containers: Reopen in Container" from View > Command Palette.
22
22
23
+
*IMPORTANT: If using this dev container configuration, you will need to set the `DB_HOST` environment variable to "host.docker.internal" in the `.env` file.*
24
+
23
25
## Install development dependencies manually
24
26
25
27
### Python and Docker
@@ -103,15 +105,32 @@ Set your desired database name, username, and password in the .env file.
103
105
104
106
To use password recovery, register a [Resend](https://resend.com/) account, verify a domain, get an API key, and paste the API key into the .env file.
105
107
108
+
If using the dev container configuration, you will need to set the `DB_HOST` environment variable to "host.docker.internal" in the .env file. Otherwise, set `DB_HOST` to "localhost" for local development. (In production, `DB_HOST` will be set to the hostname of the database server.)
109
+
106
110
## Start development database
107
111
112
+
To start the development database, run the following command in your terminal from the root directory:
113
+
108
114
```bash
109
115
docker compose up -d
110
116
```
111
117
118
+
If at any point you change the environment variables in the .env file, you will need to stop the database service *and tear down the volume*:
119
+
120
+
```bash
121
+
# Don't forget the -v flag to tear down the volume!
122
+
docker compose down -v
123
+
```
124
+
125
+
You may also need to restart the terminal session to pick up the new environment variables. You can also add the `--force-recreate` and `--build` flags to the startup command to ensure the container is rebuilt:
126
+
127
+
```bash
128
+
docker compose up -d --force-recreate --build
129
+
```
130
+
112
131
## Run the development server
113
132
114
-
Make sure the development database is running and tables and default permissions/roles are created first.
133
+
Before running the development server, make sure the development database is running and tables and default permissions/roles are created first. Then run the following command in your terminal from the root directory:
0 commit comments