Started to migrate the documentation to github pages

docs/installation/docker-compose.yaml

@@ -0,0 +1,43 @@
+version: '3.3'
+services:
+  partdb:
+    container_name: partdb
+    # By default Part-DB will be running under Port 8080, you can change it here
+    ports:
+      - '8080:80'
+    volumes:
+      # By default
+      - ./uploads:/var/www/html/uploads
+      - ./public_media:/var/www/html/public/media
+      - ./db:/var/www/html/var/db
+    restart: unless-stopped
+    image: jbtronics/part-db1:latest
+    environment:
+      # Put SQLite database in our mapped folder. You can configure some other kind of database here too.
+      - DATABASE_URL=sqlite:///%kernel.project_dir%/var/db/app.db
+      # In docker env logs will be redirected to stderr
+      - APP_ENV=docker
+
+      # You can configure Part-DB using environment variables
+      # Below you can find the most essential ones predefined
+      # However you can add add any other environment configuration you want here
+      # See .env file for all available options or https://github.com/Part-DB/Part-DB-symfony/wiki/Configuration
+
+      # The language to use serverwide as default (en, de, ru, etc.)
+      - DEFAULT_LANG=en
+      # The default timezone to use serverwide (e.g. Europe/Berlin)
+      - DEFAULT_TIMEZONE=Europe/Berlin
+      # The currency that is used inside the DB (and is assumed when no currency is set). This can not be changed later, so be sure to set it the currency used in your country
+      - BASE_CURRENCY=EUR
+      # The name of this installation. This will be shown as title in the browser and in the header of the website
+      - INSTANCE_NAME=Part-DB
+
+      # Allow users to download attachments to the server by providing an URL
+      # This could be a potential security issue, as the user can retrieve any file the server has access to (via internet)
+      - ALLOW_ATTACHMENT_DOWNLOADS=0
+      # Use gravatars for user avatars, when user has no own avatar defined
+      - USE_GRAVATAR=0
+
+      # Override value if you want to show to show a given text on homepage.
+      # When this is empty the content of config/banner.md is used as banner
+      #- BANNER=This is a test banner<br>with a line break

docs/installation/index.md

@@ -0,0 +1,9 @@
+---
+layout: default
+title: Installation
+nav_order: 2
+has_children: true
+---
+
+# Installation
+Below you can find some guides to install Part-DB.

docs/installation/installation_docker.md

@@ -0,0 +1,41 @@
+---
+title: Installation using Docker
+layout: default
+parent: Installation
+---
+
+# Installation of Part-DB via docker
+
+**Warning: The methods described here, configure PHP without HTTPS and therefore should only be used locally. If you want to expose Part-DB to the internet, you have to configure a reverse proxy!**
+
+## Docker-compose
+Part-DB can be installed via docker. A pre-built docker image is available under [jbtronics/part-db1](https://hub.docker.com/repository/docker/jbtronics/part-db1/).
+In the moment the master tag should be used (which is built from the latest commits in the master branch), as no tagged releases are available yet.
+
+The easiest way to use it is to use the docker-compose.yml available [here](https://raw.githubusercontent.com/Part-DB/Part-DB-symfony/master/docs/docker/docker-compose.yaml):
+0. Install docker and docker-compose like described under https://docs.docker.com/compose/install/
+1. Create a folder where the Part-DB data should live
+2. Download docker-compose.yml and move it to the folder created above
+3. Inside the folder, run `docker-compose up -d`
+4. Create the inital database with `docker exec --user=www-data partdb php bin/console doctrine:migrations:migrate` and watch for the password output
+5. Part-DB is available under `http://localhost:8080` and you can log in with username `admin` and the password shown before
+
+The docker image uses a SQLite database and all data (database, uploads and other media) is put into folders relative to the docker-compose.yml.
+
+## Direct use of docker image
+You can use the `jbtronics/part-db1:master` image directly. You have to expose the port 80 to a host port and configure volumes for `/var/www/html/uploads` and `/var/www/html/public/media`.
+
+If you want to use SQLite database (which is default), you have to configure Part-DB to put the database file in a mapped volume via the `DATABASE_URL` environment variable.
+For example if you set `DATABASE_URL=sqlite:///%kernel.project_dir%/var/db/app.db` then you will have to map the `/var/www/html/var/db/` folder to the docker container (see docker-compose.yaml for example).
+
+You also have to create the database like described above in step 4.
+
+## Running console commands
+You can run the console commands described in README by executing `docker exec --user=www-data -it partdb bin/console [command]`
+
+## Troubleshooting
+
+*Login not possible. Login page is just reloading and no error message is shown or something like "CSFR token invalid"*:
+
+Clear all cookies in your browser or use a inkognito tab for Part-DB.
+This related to the fact that Part-DB can not set cookies via HTTP, after some webpage has set cookies before under localhost via https. This is a security mechanism of the browser and can not be bypassed by Part-DB.

docs/installation/installation_guide-debian.md

@@ -1,3 +1,9 @@
+---
+title: Direct Installation on Debian 11
+layout: default
+parent: Installation
+---
+
 # Part-DB installation guide for Debian 11 (Bullseye)
 This guide shows you how to install Part-DB directly on Debian 11 using apache2 and SQLite. This guide should work with recent Ubuntu and other Debian based distributions with little to no changes.
 Depending on what you want to do, using the prebuilt docker images may be a better choice, as you dont need to install this much dependencies. See **TODO** for more information of the docker installation.