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
### Description
Improved grammar, structure, and tone of the `docs/self_hosting.md` file
for better clarity and consistency. Changes include fixing typos,
rewording vague instructions, improving formatting, and aligning with
the overall documentation tone.
### Checks
- [x] Make sure the PR title follows the Conventional Commits standard.
(https://www.conventionalcommits.org for more info)
- [x] Make sure to include your GitHub username prefixed with @ inside
parentheses at the end of the PR title.
### Other notes
This PR does not add any quotes, languages, themes, or layouts.
---
Closes # (none)
Copy file name to clipboardExpand all lines: docs/SELF_HOSTING.md
+14-15Lines changed: 14 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,12 +25,12 @@
25
25
26
26
27
27
## Prerequisites
28
-
- you need `docker` and `docker-compose-plugin` installed. Follow the [docker documentation](https://docs.docker.com/compose/install/) on how to do this.
28
+
- you need to have `docker` and `docker-compose-plugin` installed. Follow the [docker documentation](https://docs.docker.com/compose/install/) on how to do this.
29
29
30
30
## Quickstart
31
31
32
-
- create a new directory, e.g. `monkeytype` and open it.
33
-
- download the [docker-compose.yml](https://github.com/monkeytypegame/monkeytype/tree/master/docker/docker-compose.yml)
32
+
- create a new directory (e.g. `monkeytype`) and navigate into it.
33
+
- download the [docker-compose.yml](https://github.com/monkeytypegame/monkeytype/tree/master/docker/docker-compose.yml) file.
34
34
- create an `.env` file, you can copy the content from the [example.env](https://github.com/monkeytypegame/monkeytype/tree/master/docker/example.env).
35
35
- download the [backend-configuration.json](https://github.com/monkeytypegame/monkeytype/tree/master/docker/backend-configuration.json)
36
36
- run `docker compose up -d`
@@ -39,7 +39,7 @@
39
39
40
40
## Account System
41
41
42
-
User signup/login is disabled by default. To allow users to signup you'll need to setup a Firebase project.
42
+
By default, user sign-up and login are disabled. To enable this, you'll need to set up a Firebase project.
43
43
Stop the running docker containers using `docker compose down` before making any changes.
44
44
45
45
### Setup Firebase
@@ -53,11 +53,11 @@ Stop the running docker containers using `docker compose down` before making any
53
53
- go to `Authentication > Sign-in method`
54
54
- enable `Email/Password` and save
55
55
- generate service account
56
-
-open the project settings by clicking the `⚙` icon on the sidebar and`Project settings`
57
-
-go to `Service accounts`
58
-
- click `Generate new private key`. This will download a`.json` file.
59
-
-store the `.json` file as `serviceAccountKey.json`
60
-
- update the `docker-compose.yml`file and uncomment the first volume from the `monkeytype-backend` container
56
+
-go to your project settings by clicking the `⚙` icon in the sidebar, then`Project settings`
57
+
-navigate to the `Service accounts` tab
58
+
- click `Generate new private key` to download the`.json` file.
59
+
-save it as `serviceAccountKey.json`
60
+
- update `docker-compose.yml` and uncomment the volume block in the `monkeytype-backend` container to mount the Firebase service account:
61
61
```yaml
62
62
#uncomment to enable the account system, check the SELF_HOSTING.md file
63
63
- type: bind
@@ -69,12 +69,12 @@ Stop the running docker containers using `docker compose down` before making any
69
69
- update the `.env` file
70
70
- open the [firebase console](https://console.firebase.google.com/) and open your project
71
71
- open the project settings by clicking the `⚙` icon on the sidebar and `Project settings`
72
-
- if there is no app in your project create a new web-app `</>`
72
+
- if your project has no apps yet, create a new Web app (`</>` icon)
73
73
- nickname `monkeytype`
74
74
- uncheck `set up firebase hosting`
75
75
- click `Register app`
76
76
- select your app and select `Config` for `SDK setup and configuration`
77
-
- it will display sth like this:
77
+
- it will display something like this:
78
78
```
79
79
const firebaseConfig = {
80
80
apiKey: "AAAAAAAA",
@@ -112,7 +112,7 @@ Stop the running docker containers using `docker compose down` before making any
112
112
### Setup Recaptcha
113
113
114
114
- [create](https://www.google.com/recaptcha/admin/create) a new recaptcha token
115
-
- label: monkeytype
115
+
- label: `monkeytype`
116
116
- type: v2
117
117
- domain: the domain of the frontend
118
118
- update the `.env` file with the site key from the previous step
@@ -137,7 +137,7 @@ To enable emails for password reset and email verification update the following
137
137
EMAIL_HOST=mail.myserver # your mailserver domain
138
138
EMAIL_USER=mailuser # username to authenticate with your mailserver
139
139
EMAIL_PASS=mailpass # password for the user
140
-
EMAIL_PORT=465 # port, likely 465 or 578
140
+
EMAIL_PORT=465 # port, likely 465 or 587
141
141
EMAIL_FROM="Support <noreply@myserver>"
142
142
```
143
143
@@ -185,5 +185,4 @@ Contains your firebase config, only needed if you want to allow users to signup.
185
185
Configuration of the backend. Check the [default configuration](https://github.com/monkeytypegame/monkeytype/blob/master/backend/src/constants/base-configuration.ts#L8) for possible values.
186
186
187
187
> [!NOTE]
188
-
> The configuration is applied on container startup only. You have to restart the container for your changes to become active.
189
-
188
+
> Configuration changes are applied only on container startup. You must restart the container for your updates to take effect.
0 commit comments