feat: Added instructions for Docker compose

(Secretly, I did not test this at all and hoping for the best)
This commit is contained in:
Cyper committed 2026-05-01 22:36:03 -04:00
1 parent 3a4afda503
commit 1d21e48c80
1 file changed
+18
+18
View File
@@ -25,6 +25,24 @@ Setting up the application will consist of the following:
## Database Setup
### Docker
You have two options for setting up your database: configuring the Docker compose file or installing and
configuring a server manually. If you choose to use Docker, all you have to do is configure the following
values in the `compose.yaml` file:
- `MYSQL_ROOT_PASSWORD`
- `MYSQL_DATABASE`
- `MYSQL_USER`
- `MYSQL_PASSWORD`
You may also configure the port if desired. Whatever values you enter for the above `compose.yaml` file
must also be copied to your `.env` file. See [Configuring Environment File](#configuring-environment-file) for more info.
After configuring the Docker compose file, all you have to do is run `docker compose up -d`.
### Manual Install
This project was created using MariaDB and uses `@prisma/adapter-mariadb`. While MariaDB is compliant with
MySQL and will probably have no issues working with MySQL, it is highly advised you use MariaDB for your
database.