Skip to content

Commit e5f8cb3

Browse files
authored
docs(self-hosting): improve grammar and structure of setup guide (@nitin-is-me) (monkeytypegame#6774)
### 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)
1 parent 2180e3b commit e5f8cb3

File tree

1 file changed

+14
-15
lines changed

1 file changed

+14
-15
lines changed

docs/SELF_HOSTING.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@
2525

2626

2727
## 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.
2929

3030
## Quickstart
3131

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.
3434
- create an `.env` file, you can copy the content from the [example.env](https://github.com/monkeytypegame/monkeytype/tree/master/docker/example.env).
3535
- download the [backend-configuration.json](https://github.com/monkeytypegame/monkeytype/tree/master/docker/backend-configuration.json)
3636
- run `docker compose up -d`
@@ -39,7 +39,7 @@
3939

4040
## Account System
4141

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.
4343
Stop the running docker containers using `docker compose down` before making any changes.
4444

4545
### Setup Firebase
@@ -53,11 +53,11 @@ Stop the running docker containers using `docker compose down` before making any
5353
- go to `Authentication > Sign-in method`
5454
- enable `Email/Password` and save
5555
- 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:
6161
```yaml
6262
#uncomment to enable the account system, check the SELF_HOSTING.md file
6363
- type: bind
@@ -69,12 +69,12 @@ Stop the running docker containers using `docker compose down` before making any
6969
- update the `.env` file
7070
- open the [firebase console](https://console.firebase.google.com/) and open your project
7171
- 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)
7373
- nickname `monkeytype`
7474
- uncheck `set up firebase hosting`
7575
- click `Register app`
7676
- 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:
7878
```
7979
const firebaseConfig = {
8080
apiKey: "AAAAAAAA",
@@ -112,7 +112,7 @@ Stop the running docker containers using `docker compose down` before making any
112112
### Setup Recaptcha
113113

114114
- [create](https://www.google.com/recaptcha/admin/create) a new recaptcha token
115-
- label: monkeytype
115+
- label: `monkeytype`
116116
- type: v2
117117
- domain: the domain of the frontend
118118
- 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
137137
EMAIL_HOST=mail.myserver # your mailserver domain
138138
EMAIL_USER=mailuser # username to authenticate with your mailserver
139139
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
141141
EMAIL_FROM="Support <noreply@myserver>"
142142
```
143143

@@ -185,5 +185,4 @@ Contains your firebase config, only needed if you want to allow users to signup.
185185
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.
186186

187187
> [!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

Comments
 (0)