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/Getting-Started/Quick-Start-Guide.md
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,10 +11,10 @@ This quick start guide will help you get a RomM instance up and running. It is s
11
11
This guide will assume that you already have the following done, if not - stop here and come back when you do.
12
12
13
13
- Docker and Docker Compose installed
14
-
- A [Twitch](https://dev.twitch.tv) account (optional)
14
+
- A <ahref="https://dev.twitch.tv"target="_blank"rel="noopener noreferrer">Twitch</a> account (optional)
15
15
- 2-factor authentication set up on your Twitch account
16
16
-_This is required to get a developer account and an IGDB key_
17
-
- A [Screenscraper](https://www.screenscraper.fr/) account (optional)
17
+
- A <ahref="https://www.screenscraper.fr/"target="_blank"rel="noopener noreferrer">Screenscraper</a> account (optional)
18
18
- Your ROMs organized in the correct [folder structure](../Folder-Structure)
19
19
20
20
<!-- prettier-ignore -->
@@ -30,44 +30,44 @@ Head over to [API key docs](../Generate-API-Keys) to get your IGDB and/or Screen
30
30
Now that we have everything gathered, we can begin getting your instance set up!
31
31
32
32
<!-- trunk-ignore-begin(markdownlint/MD040) -->
33
-
1. Download a copy of the latest [docker-compose.example.yml](https://github.com/rommapp/romm/blob/release/examples/docker-compose.example.yml) file from GitHub
34
-
2. Edit the file and modify the following values to configure the database
33
+
1. Download a copy of the latest <ahref="https://github.com/rommapp/romm/blob/release/examples/docker-compose.example.yml"target="_blank"rel="noopener noreferrer">docker-compose.example.yml</a> file from GitHub
34
+
3. Edit the file and modify the following values to configure the database
35
35
-`MARIADB_ROOT_PASSWORD`: Sets the root password of the database. Use a unique and secure password (_use a password generator for simplicity_)
36
36
-`MARIADB_DATABASE`: Sets the database name for RomM. This can be modified - but it's not necessary
37
37
-`MARIADB_USER`: User to connect to the database with. This can be modified - but it's not necessary
38
38
-`MARIADB_PASSWORD`: Password for the user to connect to the database with. Use a unique and secure password (_use a password generator for simplicity_)
39
-
3. Modify the following values in the **environment** to configure the application. _-- Other values can be changed, but should not be done unless you know what you are doing, and are outside the scope of this guide_
39
+
4. Modify the following values in the **environment** to configure the application. _-- Other values can be changed, but should not be done unless you know what you are doing, and are outside the scope of this guide_
40
40
-`DB_NAME`: Name of the database set in the database section
41
41
-`DB_USER`: Name of the user to connect to the database
42
42
-`DB_PASSWD`: Password of the user to connect to the database
43
-
4. Run the following command in a terminal and save the output to the `ROMM_AUTH_SECRET_KEY` environment variable:
43
+
5. Run the following command in a terminal and save the output to the `ROMM_AUTH_SECRET_KEY` environment variable:
0 commit comments