Merge pull request #428 from johanngrobe/docs

add bare-metal docs

docs/getting-started/bare-metal.md

@@ -0,0 +1,172 @@
+# Bare-Metal Installation Guide
+
+This guide explains how to install **Endurain** bare-metal on Debian without Docker.
+
+## 1. Install Required Dependencies
+
+```bash
+apt install -y \
+  default-libmysqlclient-dev \
+  build-essential \
+  pkg-config  \
+  git \
+  curl \
+  python3-dev
+```
+
+## 2. Install Required Runtime Tools
+
+Install the required tools from their official sources:
+
+- uv (Python) → https://docs.astral.sh/uv/
+- Node.js 22 → https://nodejs.org/en/download
+- PostgreSQL 17 → https://www.postgresql.org/download/
+
+## 3. Download Endurain Release
+
+Run the following command to download and unpack the latest release.
+
+```bash
+mkdir -p /path/to/endurain
+cd /path/to/endurain
+
+TAG=$(curl -s https://api.github.com/repos/joaovitoriasilva/endurain/releases/latest \
+  | grep -oP '"tag_name": "\K(.*)(?=")')
+curl -L "https://github.com/joaovitoriasilva/endurain/archive/refs/tags/$TAG.tar.gz" \
+  | tar xz
+EXTRACTED=$(ls -d endurain-*)
+shopt -s dotglob
+mv "$EXTRACTED"/* .
+shopt -u dotglob
+rm -rf "$EXTRACTED"
+```
+
+## 4. Create Environment Configuration
+
+Prepare data storage.
+
+```bash
+mkdir -p /path/to/endurain_data/{data,logs}
+```
+
+Copy the provided example.
+
+```bash
+cp /path/to/endurain/.env.example /path/to/endurain/.env
+```
+
+Generate your `SECRET_KEY` and `FERNET_KEY`. These keys are required for Endurain to work, so be sure to paste them into your `.env` file.
+
+```bash
+openssl rand -hex 32 # SECRET_KEY
+openssl rand -base64 32 # FERNET_KEY
+```
+
+Edit `.env` file.
+
+```bash
+nano /path/to/endurain/.env
+```
+
+Adjust the environment variables and set keys. You definitely have to adjust `FRONTEND_DIR` and `BACKEND_DIR`.  
+Environment variables are explained in the  
+[Environment Variables Guide](advanced-started.md).
+
+```env
+BACKEND_DIR="/path/to/endurain/backend/app"
+FRONTEND_DIR="/path/to/endurain/frontend/app/dist"
+DATA_DIR="/path/to/endurain_data/data"
+LOGS_DIR="/path/to/endurain_data/logs"
+```
+
+## 5. Build the Frontend
+
+```bash
+cd /path/to/endurain/frontend/app
+npm ci
+npm run build
+```
+
+Create `env.js`. Edit the URL if you use a reverse proxy.
+
+```bash
+cat << 'EOF' > /path/to/endurain/frontend/app/dist/env.js
+window.env = {
+  ENDURAIN_HOST: "http://YOUR_SERVER_IP:8080",
+};
+EOF
+```
+
+## 6. Set Up the Backend
+
+```bash
+cd /path/to/endurain/backend
+
+uv tool install poetry
+uv tool update-shell
+export PATH="/root/.local/bin:$PATH"
+
+poetry self add poetry-plugin-export
+poetry export -f requirements.txt --output requirements.txt --without-hashes
+
+uv venv
+uv pip install -r requirements.txt
+```
+
+## 7. Setup Postgres Database
+
+Run the following commands to create a PostgreSQL user and database for Endurain:
+
+```bash
+sudo -u postgres createuser -P endurain
+sudo -u postgres createdb -O endurain endurain
+```
+
+Check that the PostgreSQL client and server encodings are set to UTF-8.
+
+```bash
+sudo -u postgres psql -c "SHOW client_encoding;"
+sudo -u postgres psql -c "SHOW server_encoding;"
+```
+
+If either value is SQL_ASCII, set UTF-8 explicitly for the user and the database.
+
+```bash
+sudo -u postgres psql -c "ALTER ROLE endurain SET client_encoding = 'UTF8';"
+sudo -u postgres psql -c "ALTER DATABASE endurain SET client_encoding = 'UTF8';"
+```
+
+This ensures that all connections to the endurain database default to proper UTF-8 encoding.
+
+## 8. Systemd Service
+
+This is an example how you could set up your systemd service.
+
+```bash
+cat << 'EOF' > /etc/systemd/system/endurain.service
+[Unit]
+Description=Endurain FastAPI Backend
+After=network.target postgresql.service
+
+[Service]
+WorkingDirectory=/path/to/endurain/backend/app
+EnvironmentFile=/path/to/endurain/.env
+ExecStart=/path/to/endurain/backend/.venv/bin/uvicorn main:app --host 0.0.0.0 --port 8080
+Restart=always
+RestartSec=5
+User=root
+StandardOutput=journal
+StandardError=journal
+
+[Install]
+WantedBy=multi-user.target
+EOF
+```
+
+Enable and start the service.
+
+```bash
+systemctl daemon-reload
+systemctl enable endurain
+systemctl start endurain
+```

mkdocs.yml

@@ -19,11 +19,12 @@ theme:
 nav:
   - Home: index.md
   - Hosting Guide:
-    - Getting started easy: getting-started/getting-started.md
+      - Getting started easy: getting-started/getting-started.md
-    - Getting started advanced: getting-started/advanced-started.md
+      - Getting started advanced: getting-started/advanced-started.md
-    - MariaDB to Postgres migration: getting-started/maria-to-postgres-migration.md
+      - Bare-Metal Installation Guide: getting-started/bare-metal.md
+      - MariaDB to Postgres migration: getting-started/maria-to-postgres-migration.md
   - Integrations:
-    - 3rd party apps: integrations/3rd-party-apps.md
+      - 3rd party apps: integrations/3rd-party-apps.md
-    - 3rd party services: integrations/3rd-party-services.md
+      - 3rd party services: integrations/3rd-party-services.md
   - Developer guide: developer-guide.md
-  - Gallery: gallery.md
+  - Gallery: gallery.md