mirror of
https://github.com/seanmorley15/AdventureLog.git
synced 2025-07-21 13:59:36 +02:00
docs
This commit is contained in:
Sean Morley
parent
dc49416bf6
commit
22a1acba3b
4 changed files with 46 additions and 72 deletions
|
|
@ -1,32 +0,0 @@
|
||||||
version: "3.9"
|
|
||||||
|
|
||||||
services:
|
|
||||||
db:
|
|
||||||
image: postgres:latest
|
|
||||||
environment:
|
|
||||||
POSTGRES_DB: database
|
|
||||||
POSTGRES_USER: adventure
|
|
||||||
POSTGRES_PASSWORD: changeme123
|
|
||||||
volumes:
|
|
||||||
- postgres_data:/var/lib/postgresql/data/
|
|
||||||
|
|
||||||
web:
|
|
||||||
build: .
|
|
||||||
environment:
|
|
||||||
- PGHOST=db
|
|
||||||
- PGDATABASE=database
|
|
||||||
- PGUSER=adventure
|
|
||||||
- PGPASSWORD=changeme123
|
|
||||||
- SECRET_KEY=changeme123
|
|
||||||
ports:
|
|
||||||
- "8000:8000"
|
|
||||||
depends_on:
|
|
||||||
- db
|
|
||||||
volumes:
|
|
||||||
- adventurelog_media:/code/media/
|
|
||||||
|
|
||||||
volumes:
|
|
||||||
postgres_data:
|
|
||||||
driver: local
|
|
||||||
adventurelog_media:
|
|
||||||
driver: local
|
|
||||||
|
|
@ -3,3 +3,46 @@ sidebar_position: 1
|
||||||
---
|
---
|
||||||
|
|
||||||
# Docker 🐋
|
# Docker 🐋
|
||||||
|
|
||||||
|
Docker is the perffered way to run AdventureLog on your local machine. It is a lightweight containerization technology that allows you to run applications in isolated environments called containers.
|
||||||
|
**Note**: This guide mainly focuses on installation with a linux based host machine, but the steps are similar for other operating systems.
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
- Docker installed on your machine/server. You can learn how to download it [here](https://docs.docker.com/engine/install/).
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
Get the `docker-compose.yml` file from the AdventureLog repository. You can download it from [here](https://github.com/seanmorley15/AdventureLog/blob/main/docker-compose.yml) or run this command to download it directly to your machine:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
wget https://raw.githubusercontent.com/seanmorley15/AdventureLog/main/docker-compose.yml
|
||||||
|
```
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
Here is a summary of the configuration options available in the `docker-compose.yml` file:
|
||||||
|
|
||||||
|
<!-- make a table with colum name, is required, other -->
|
||||||
|
|
||||||
|
### Frontend Container (web)
|
||||||
|
|
||||||
|
| Name | Required | Description | Default Value |
|
||||||
|
| ------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
|
||||||
|
| `PUBLIC_SERVER_URL` | Yes | What the frontend SSR server uses to connect to the backend. | http://server:8000 |
|
||||||
|
| `ORIGIN` | Sometimes | Not needed if using HTTPS. If not, set it to the domain of what you will acess the app from. | http://localhost:8080 |
|
||||||
|
| `BODY_SIZE_LIMIT` | Yes | Used to set the maximum upload size to the server. Should be changed to prevent someone from uploading too much! Custom values must be set in **kiliobytes**. | Infinity |
|
||||||
|
|
||||||
|
### Backend Container (server)
|
||||||
|
|
||||||
|
| Name | Required | Description | Default Value |
|
||||||
|
| ----------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- |
|
||||||
|
| `PGHOST` | Yes | Databse host. | db |
|
||||||
|
| `PGDATABASE` | Yes | Database. | database |
|
||||||
|
| `PGUSER` | Yes | Database user. | adventure |
|
||||||
|
| `PGPASSWORD` | Yes | Database password. | changeme123 |
|
||||||
|
| `DJANGO_ADMIN_USERNAME` | Yes | Default username. | admin |
|
||||||
|
| `DJANGO_ADMIN_PASSWORD` | Yes | Default password, change after inital login. | admin |
|
||||||
|
| `DJANGO_ADMIN_EMAIL` | Yes | Default user's email. | admin@example.com |
|
||||||
|
| `PUBLIC_URL` | Yes | This is the publically accessible url to the **nginx** container. You should be able to acess nginx from this url where you access your app. | http://127.0.0.1:81 |
|
||||||
|
| `CSRF_TRUSTED_ORIGINS` | Yes | Need to be changed to the orgins where you use your backend server and frontend. These values are comma seperated. | Needs to be changed. |
|
||||||
|
|
|
||||||
|
|
@ -6,42 +6,4 @@ sidebar_position: 1
|
||||||
|
|
||||||
This tutorial will guide you how to get AdventureLog up and running on your local machine quickly and easily.
|
This tutorial will guide you how to get AdventureLog up and running on your local machine quickly and easily.
|
||||||
|
|
||||||
## Getting Started
|
Choose a next below to get started:
|
||||||
|
|
||||||
Get started by **creating a new site**.
|
|
||||||
|
|
||||||
Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**.
|
|
||||||
|
|
||||||
### What you'll need
|
|
||||||
|
|
||||||
- [Node.js](https://nodejs.org/en/download/) version 18.0 or above:
|
|
||||||
- When installing Node.js, you are recommended to check all checkboxes related to dependencies.
|
|
||||||
|
|
||||||
## Generate a new site
|
|
||||||
|
|
||||||
Generate a new Docusaurus site using the **classic template**.
|
|
||||||
|
|
||||||
The classic template will automatically be added to your project after you run the command:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm init docusaurus@latest my-website classic
|
|
||||||
```
|
|
||||||
|
|
||||||
You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.
|
|
||||||
|
|
||||||
The command also installs all necessary dependencies you need to run Docusaurus.
|
|
||||||
|
|
||||||
## Start your site
|
|
||||||
|
|
||||||
Run the development server:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cd my-website
|
|
||||||
npm run start
|
|
||||||
```
|
|
||||||
|
|
||||||
The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.
|
|
||||||
|
|
||||||
The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.
|
|
||||||
|
|
||||||
Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.
|
|
||||||
|
|
|
||||||
|
|
@ -23,7 +23,8 @@
|
||||||
|
|
||||||
{#if data.user && data.user.first_name && data.user.last_name}
|
{#if data.user && data.user.first_name && data.user.last_name}
|
||||||
<h1 class="text-center text-4xl font-bold">
|
<h1 class="text-center text-4xl font-bold">
|
||||||
{data.user.first_name}, {data.user.last_name}
|
{data.user.first_name}
|
||||||
|
{data.user.last_name}
|
||||||
</h1>
|
</h1>
|
||||||
{/if}
|
{/if}
|
||||||
<p class="text-center text-lg mt-2">{data.user.username}</p>
|
<p class="text-center text-lg mt-2">{data.user.username}</p>
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue