chore: doc updates

This commit is contained in:
2025-06-14 11:32:56 -04:00
parent 2c73c3ba4c
commit 07c0977aa7
2 changed files with 17 additions and 0 deletions
+9
View File
@@ -31,5 +31,14 @@ Has an automatic backup on a CRON that outputs to the root volume.
### How to build? ### How to build?
The whole thing should run by using docker. The whole thing should run by using docker.
```bash
docker compose up
```
There is a docker-compose file in the root, I would suggest changing the user/password to your db if you ever intend for this to leave your home network. There is a docker-compose file in the root, I would suggest changing the user/password to your db if you ever intend for this to leave your home network.
I'm sure there are a lot of other security measures as well, but at the time of writing this I'm not particular about the security for the web application 2 people might view. I'm sure there are a lot of other security measures as well, but at the time of writing this I'm not particular about the security for the web application 2 people might view.
### I have a bug
If you run into any issues feel free to email me at `alexander.muszynski@gmail.com` with the subject being `BlogSiteGitea: {myissue}` or make an issue on the gitea repo. I may or may not get around to it, I just work on this as I feel like it.
+8
View File
@@ -1 +1,9 @@
# Server # Server
The server is built using FastAPI on port `8000`.
If you are running locally you can view all the apis by navigating to `localhost:8000/docs`
This project uses `sqlalchemy` and `alembic` to access and manage the database which is a `postgresql` instance that is also created during the docker compose step.
I would suggest using docker compose for all testing as that is what I will do, running the server in isolation may have bugs so be cautious.