Added documentation

Author: SamTV12345

.github/workflows/build-documentation.yml

@@ -0,0 +1,21 @@
+name: Build mdBook
+on:
+  push:
+    #branches:
+    #  - main
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+        steps:
+        - uses: actions/checkout@v2
+        - name: Install mdBook
+          uses: peaceiris/actions-mdbook@v1
+        - name: Build mdBook
+          run: mdbook build
+          working-directory: docs
+        - name: Deploy to GitHub Pages
+          uses: peaceiris/actions-gh-pages@v3
+          with:
+              github_token: ${{ secrets.GITHUB_TOKEN }}
+              publish_dir: ./docs/book

docs/.gitignore

@@ -0,0 +1 @@
+book

docs/book.toml

@@ -0,0 +1,6 @@
+[book]
+authors = ["SamTV12345"]
+language = "en"
+multilingual = false
+src = "src"
+title = "PodFetch Documentation"

docs/build.manifest

@@ -24,5 +24,5 @@ To enable it you need to set the following variables:
 
 You can acquire the Telegram Bot chat id with the following steps:
 1. Write a message to the bot
-2. Open the following url in your browser: https://api.telegram.org/bot<TELEGRAM_BOT_TOKEN>/getUpdates
+2. Open the following url in your browser: [Telegram API page](https://api.telegram.org/bot<TELEGRAM_BOT_TOKEN>/getUpdates)
 3. Search for the chat id in the response

docs/AUTH.md renamed to docs/src/AUTH.md

@@ -0,0 +1,46 @@
+# Installation
+
+## Installation with Docker
+
+## Installation with Docker (SQLite)
+
+```yaml
+version: '3'
+services:
+  podfetch:
+    image: samuel19982/podfetch:latest
+    user: ${UID:-1000}:${GID:-1000}
+    ports:
+      - "80:8000"
+    volumes:
+      - podfetch-podcasts:/app/podcasts
+      - podfetch-db:/app/db
+    environment:
+      - POLLING_INTERVAL=60
+      - SERVER_URL=http://localhost:80
+      - DATABASE_URL=sqlite:///app/db/podcast.db
+
+volumes:
+    podfetch-podcasts:
+    podfetch-db:
+```
+
+It is important to change `UID` and `GID` to your user id and group id so that the files are owned by you and not by root.
+Docker will create the volumes by default as root and podfetch will not be able to write to them.
+
+## Installation with Docker (Postgres)
+
+To use postgres you need to set the following environment variables:
+
+```yaml
+- DATABASE_URL=postgres://postgres:postgres@postgres:5432/podfetch
+```
+
+
+## Installation without Docker
+
+### Requirements
+- Download the latest release from the [release page](https://github.com/SamTV12345/PodFetch/releases)
+- Create a shell script that sets the above environment variables and starts the podfetch binary
+- Make the shell script executable
+- Run the shell script

docs/CLI.md renamed to docs/src/CLI.md

@@ -0,0 +1,14 @@
+# Introduction
+
+PodFetch is a simple, lightweight, fast, and efficient podcast downloader for hosting your own podcasts.
+It supports all the features you would expect from a podcast player, including:
+- Downloading podcasts
+- Listening to podcasts
+- Searching for podcasts
+- Managing your subscriptions
+- Managing your podcast episodes
+- Managing your podcast feed
+- Host your own Gpodder compatible podcast feed
+- Start listening on your phone and continue on your computer
+
+All you need to do is download the latest release from the release page or use the listed docker-compose file to get started.

docs/HOSTING.md renamed to docs/src/HOSTING.md

@@ -0,0 +1,7 @@
+# Summary
+
+- [Introduction](./Introduction.md)
+- [Installation](./Installation.md)
+- [Authorization](./AUTH.md)
+- [UI Walkthrough](./UIWalkthrough.md)
+- [Hosting](./HOSTING.md)

docs/src/Installation.md

@@ -9,32 +9,32 @@ The podcast listening tool contains an advanced audio player that can be used to
 The tool will automatically save your progress in the current episode and will resume from where you left off even if you close the browser.
 You can continue listening on all devices by just hitting play on any episode on your home screen.
 
-![Continue listening to episodes](./continue_listening.png)
+![Continue listening to episodes](./images/continue_listening.png)
 
 ## Search for podcasts
 You can search for podcast episodes by hitting CTRL+F and typing any word that might appear in the description or title of the podcast episode you want to listen to.
-![Audio Player](./search.png)
+![Audio Player](./images/search.png)
 
 
 Below are some fullscreen images so you can get a better grasp of the UI.
 
 ## Home Screen
-![Home Screen](./home.png)
+![Home Screen](./images/home.png)
 
 
 ## Timeline View
 
-![Timeline](timeline.png)
+![Timeline](./images/timeline.png)
 
 ## Info View
 
-![Info page](Info_Page.png)
+![Info page](./images/Info_Page.png)
 
 
 ## Settings
 
-![Settings](settings.png)
+![Settings](./images/settings.png)
 
 ## Administration
 
-![Administration](administration.png)
+![Administration](./images/administration.png)