Readme standartization.

README.md

@@ -4,7 +4,7 @@ This directory contains Docker Compose setups for various self-hosted applicatio
 
 Most of these configurations use `.env` files for environment variables. These were designed to be used with Portainer, but can be used with `docker-compose` as well.
 
-## Projects
+## Current projects
 
 - [Bookstack](bookstack/README.md)
 - [DDNS Cloudflare](ddns-cloudflare/README.md)

bookstack/README.md

@@ -1,47 +1,26 @@
-# Bookstack
+# BookStack
 
-[Bookstack](https://www.bookstackapp.com/) is a simple, self-hosted, easy-to-use platform for organizing and storing information.
+BookStack is a free and open-source platform for organizing and storing information, essentially functioning as a wiki or documentation system. It is designed to be simple, self-hosted, and easy to use.
 
-## Docker Compose Setup
+[BookStack Website](https://www.bookstackapp.com/)
 
-This directory contains a Docker Compose setup for Bookstack.
+## Services
 
-### Services
+-   **bookstack**: The main BookStack application.
+-   **bookstack_database**: A MariaDB database for BookStack.
 
-- **bookstack**: The Bookstack application itself.
+## How to start
-- **bookstack_database**: A MariaDB database for Bookstack.
 
-### Volumes
+1.  Create a `.env` file based on the `.env.example` file.
+2.  Set the environment variables in the `.env` file.
+3.  Run `docker-compose up -d` to start the application.
+4.  The application will be available at the URL you specified in the `APP_URL` environment variable.
 
-- `${PATH_TO_CONFIG}`: Stores the Bookstack configuration files.
+## Setup
-- `${PATH_TO_DB}`: Stores the MariaDB database files.
 
-### Ports
+After starting the application, you can access the web interface and log in with the default credentials:
 
-- `6875:80`: The Bookstack application is accessible on port 6875.
+-   **Email**: `admin@admin.com`
+-   **Password**: `password`
 
-## Usage
+You will be prompted to change the password after your first login.
-
-1. Create a `.env` file with the following variables:
-
-```
-# Password for bookstack MySQL user
-DB_USER_PASS=<your_strong_pass>
-
-# Password for root MySQL user
-DB_ROOT_PASS=<your_strongest_pass>
-
-# Directory, where the bookstack itself will store the files
-PATH_TO_CONFIG=/path/to/bookstack/config
-
-# Directory, where MySQL data will be stored
-PATH_TO_DB=/path/to/db/data
-
-# Your timezone
-TZ=Europe/Warsaw
-
-# The IP:port or URL your application will be accessed on (ie. http://192.168.1.1:6875 or https://bookstack.mydomain.com
-APP_URL=https://bookstack.example.com
-```
-
-2. Run `docker-compose up -d` to start the containers.

ddns-cloudflare/README.md

@@ -1,31 +1,15 @@
 # Cloudflare DDNS
 
-This directory contains a Docker Compose setup for a Cloudflare DDNS client.
+This directory contains the configuration for the `favonia/cloudflare-ddns` Docker image. This image provides a DDNS client for Cloudflare, which automatically updates your DNS records when your IP address changes.
 
-This service will automatically update your Cloudflare DNS records with your public IP address.
+[GitHub Repository](https://github.com/favonia/cloudflare-ddns)
 
-## Docker Compose Setup
+## How to start
 
-### Services
+1.  Create a `.env` file based on the `.env.example` file.
+2.  Set the `CLOUDFLARE_API_TOKEN` and `DOMAINS` variables in the `.env` file.
+3.  Run `docker-compose up -d` to start the application.
 
-- **cloudflare-ddns**: The Cloudflare DDNS client.
+## Setup
 
-### Environment Variables
+After starting the application, the DDNS client will automatically update your Cloudflare DNS records.
-
-- `CLOUDFLARE_API_TOKEN`: Your Cloudflare API token.
-- `DOMAINS`: A comma-separated list of domains to update.
-- `PROXIED`: Whether or not to proxy the domains through Cloudflare.
-
-## Usage
-
-1. Create a `.env` file with the following variables:
-
-```
-# Cloudflare API key. User -> My Profile -> API tokens
-CLOUDFLARE_API_TOKEN=your_api_key
-
-# Cloudflare zone, which will be used. Dashboard -> Web Sites
-DOMAINS=your_domains
-```
-
-2. Run `docker-compose up -d` to start the container.

garmin-grafana/README.md

@@ -1,41 +1,24 @@
-# Garmin Grafana
+# Garmin-Grafana
 
-This directory contains a Docker Compose setup for a Garmin Grafana dashboard.
+This directory contains the configuration for a set of services that fetches data from Garmin Connect, stores it in InfluxDB, and visualizes it with Grafana.
 
-This setup will fetch your Garmin Connect data and store it in an InfluxDB database. You can then use Grafana to visualize the data.
+## Services
 
-## Docker Compose Setup
+-   **garmin-fetch-data**: A service that fetches data from Garmin Connect.
+-   **influxdb**: An InfluxDB database for storing Garmin Connect data.
+-   **grafana**: A Grafana instance for visualizing the data.
 
-### Services
+## How to start
 
-- **garmin-fetch-data**: Fetches your Garmin Connect data and stores it in InfluxDB.
+1.  Create a `.env` file based on the `.env.example` file.
-- **influxdb**: An InfluxDB database for storing your Garmin Connect data.
+2.  Set the `GARMINCONNECT_EMAIL` and `GARMINCONNECT_PASSWORD` variables in the `.env` file.
-- **grafana**: A Grafana instance for visualizing your Garmin Connect data.
+3.  Run `docker-compose up -d` to start the application.
 
-### Volumes
+## Setup
 
-- `${GARMINCONNECT_TOKENS}`: Stores the Garmin Connect tokens.
+After starting the application, you can access the Grafana web interface at [http://localhost:3000](http://localhost:3000) and log in with the default credentials:
-- `influxdb_data`: Stores the InfluxDB database files.
-- `grafana_data`: Stores the Grafana configuration files.
 
-### Ports
+-   **User**: `admin`
+-   **Password**: `admin`
 
-- `8086:8086`: The InfluxDB API is accessible on port 8086.
+You can then configure a new data source for InfluxDB and create dashboards to visualize your Garmin Connect data.
-- `3000:3000`: The Grafana web interface is accessible on port 3000.
-
-## Usage
-
-1. Create a `.env` file with the following variables:
-
-```
-# Your Garmin Connect email address
-GARMINCONNECT_EMAIL=<your_email>
-
-# Your Garmin Connect password, base64 encoded
-GARMINCONNECT_PASSWORD=<your_base64_encoded_password>
-
-# Path to a directory where the Garmin Connect tokens will be stored
-GARMINCONNECT_TOKENS=/path/to/garminconnect/tokens
-```
-
-2. Run `docker-compose up -d` to start the containers.

guacamole/README.md

@@ -1,30 +1,16 @@
 # Guacamole
 
-[Guacamole](https://guacamole.apache.org/) is a clientless remote desktop gateway. It supports standard protocols like VNC, RDP, and SSH.
+Apache Guacamole is a free and open-source, clientless remote desktop gateway that allows you to access remote computers and servers through a web browser. It supports standard protocols like VNC, RDP, and SSH.
 
-This directory contains a Docker Compose setup for Guacamole.
+[Apache Guacamole Website](https://guacamole.apache.org/)
 
-## Docker Compose Setup
+## How to start
 
-### Services
+1.  Create a `.env` file based on the `.env.example` file.
+2.  Set the `PATH_TO_CONFIG` variable in the `.env` file.
+3.  Run `docker-compose up -d` to start the application.
+4.  The application will be available at [http://localhost:8080](http://localhost:8080).
 
-- **guacamole**: The Guacamole application.
+## Setup
 
-### Volumes
+After starting the application, you can access the web interface and configure your connections.
-
-- `${PATH_TO_CONFIG}`: Stores the Guacamole configuration files.
-
-### Ports
-
-- `8080:8080`: The Guacamole web interface is accessible on port 8080.
-
-## Usage
-
-1. Create a `.env` file with the following variables:
-
-```
-# Path to a directory where the Guacamole configuration files will be stored
-PATH_TO_CONFIG=/path/to/guacamole/config
-```
-
-2. Run `docker-compose up -d` to start the container.

heimdall/README.md

@@ -1,24 +1,16 @@
 # Heimdall
 
-[Heimdall](https://heimdall.site/) is a dashboard for all your web applications.
+Heimdall Application Dashboard is a web-based dashboard for organizing and accessing your web applications and links. It provides a simple and elegant interface to keep all your frequently used links in one place, which you can set as your browser's start page.
 
-This directory contains a Docker Compose setup for Heimdall.
+[Heimdall Website](https://heimdall.site/)
 
-## Docker Compose Setup
+## How to start
 
-### Services
+1.  Create a `.env` file based on the `.env.example` file.
+2.  Set the `TZ` variable in the `.env` file.
+3.  Run `docker-compose up -d` to start the application.
+4.  The application will be available at [http://localhost](http://localhost).
 
-- **heimdall**: The Heimdall application.
+## Setup
 
-### Volumes
+After starting the application, you can access the web interface and start adding your applications and links.
-
-- `/home/mbuz/docker/heimdall/config:/config`: Stores the Heimdall configuration files. You should change this to a path on your own system.
-
-### Ports
-
-- `80:80`: The Heimdall web interface is accessible on port 80.
-- `443:443`: The Heimdall web interface is accessible on port 443.
-
-## Usage
-
-1. Run `docker-compose up -d` to start the container.

homepage/README.md

@@ -0,0 +1,16 @@
+# Homepage
+
+Homepage is a modern, fast, and secure application dashboard. It is highly customizable and can be configured using YAML files or Docker label discovery. The dashboard has integrations for over 100 services and is translated into multiple languages. It is a fully static and proxied application.
+
+[Homepage Website](https://gethomepage.dev/)
+
+## How to start
+
+1.  Create a `.env` file based on the `.env.example` file.
+2.  Set the `PATH_TO_CONFIG` variable in the `.env` file to the directory where you want to store the configuration files.
+3.  Run `docker-compose up -d` to start the application.
+4.  The application will be available at [http://localhost:3001](http://localhost:3001).
+
+## Setup
+
+After starting the application, you can configure it by editing the YAML files in the `${PATH_TO_CONFIG}` directory. The documentation for the configuration can be found on the [Homepage website](https://gethomepage.dev/en/configs/).

immich/README.md

@@ -1,14 +1,23 @@
-!!! ATTENTION !!!
+# Immich
-The docker-compose.yaml that is present here is redesigned so that it can be used in Portainer. 
-If you want to run it from the docker compose command line, just replace stack.env with .env
 
-Sometimes Immich may return error 500 after startup. It helps to stop all containers and then start them in that order:
+Immich is a free and open-source, self-hosted photo and video management application. It is designed to be a private alternative to cloud-based services like Google Photos, allowing you to store and manage your media on your own hardware. This gives you complete control over your data and privacy.
-1. immich_postgres, immich_redis, immich_typesense
-2. Here you need to wait 3-5 minutes to be sure, that typesense is running correctly
-3. Rest of the containers, including immich_server
 
-NGINX Reverse Proxy note
+[Immich Website](https://immich.app/)
 
-After 1.94 you must enable Websockets Support in the proxy host settings, as they now are used to check the server status from the frontend.
+## Services
 
-![Example](image.png)
+-   **immich-server**: The main application server.
+-   **immich-machine-learning**: Handles machine learning tasks like image tagging and object recognition.
+-   **redis**: A Redis server for caching.
+-   **database**: A PostgreSQL database for storing application data.
+
+## How to start
+
+1.  Create a `.env` file based on the `.env.example` file.
+2.  Set the `UPLOAD_LOCATION` and `DB_DATA_LOCATION` variables in the `.env` file.
+3.  Run `docker-compose up -d` to start the application.
+4.  The application will be available at [http://localhost:2283](http://localhost:2283).
+
+## Setup
+
+After starting the application, you can access the web interface and create a new user. You can also download the mobile apps for Android and iOS to automatically back up your photos and videos.

it-tools/README.md

@@ -0,0 +1,14 @@
+# IT-Tools
+
+IT-Tools is a collection of over 80 developer utilities in one place. This includes tools for cryptography, data conversion, web development, and more.
+
+[IT-Tools Website](https://it-tools.tech/)
+
+## How to start
+
+1.  Run `docker-compose up -d` to start the application.
+2.  The application will be available at [http://localhost:8182](http://localhost:8182).
+
+## Setup
+
+No special setup is required. Just open the web interface and you will have access to all the tools.

mealie/README.md

@@ -0,0 +1,16 @@
+# Mealie
+
+Mealie is a self-hosted, open-source application for managing recipes and planning meals. It is designed to be a centralized place for your recipes, allowing you to store, organize, and access them from any device.
+
+[Mealie Website](https://mealie.io/)
+
+## How to start
+
+1.  Create a `.env` file based on the `.env.example` file.
+2.  Set the `DATA_FOLDER` and `YOUR_DOMAIN` variables in the `.env` file.
+3.  Run `docker-compose up -d` to start the application.
+4.  The application will be available at [http://localhost:9925](http://localhost:9925).
+
+## Setup
+
+After starting the application, you can access the web interface and create a new user. You can then start adding your recipes and planning your meals.

nextcloud/README.md

@@ -0,0 +1,21 @@
+# Nextcloud
+
+Nextcloud is a suite of open-source software that allows you to create your own self-hosted platform for file storage, sharing, and collaboration. It is a popular alternative to commercial cloud services like Google Drive, Dropbox, or Microsoft 365, with the main difference being that you have full control over your data.
+
+[Nextcloud Website](https://nextcloud.com/)
+
+## Services
+
+-   **nextcloud**: The main Nextcloud application.
+-   **nextcloud-mariadb**: A MariaDB database for Nextcloud.
+
+## How to start
+
+1.  Create a `stack.env` file based on the `stack.env.example` file.
+2.  Set the environment variables in the `stack.env` file.
+3.  Run `docker-compose up -d` to start the application.
+4.  The application will be available at [https://localhost:5443](https://localhost:5443).
+
+## Setup
+
+After starting the application, you can access the web interface and create a new admin user. You can then install apps and configure the application to your needs.

nginx-proxy-manager/README.md

@@ -0,0 +1,21 @@
+# Nginx Proxy Manager
+
+Nginx Proxy Manager (NPM) is an open-source tool that provides a simple, web-based graphical user interface (GUI) for managing Nginx reverse proxies. It's designed to simplify the complexities of configuring web servers, SSL certificates, and reverse proxies, making it accessible even for users without deep expertise in Nginx or command-line operations.
+
+[Nginx Proxy Manager Website](https://nginxproxymanager.com/)
+
+## How to start
+
+1.  Create a `.env` file based on the `.env.example` file.
+2.  Set the `NGINX_DATA` and `NGINX_LETSENCRYPT` variables in the `.env` file.
+3.  Run `docker-compose up -d` to start the application.
+4.  The application will be available at [http://localhost:81](http://localhost:81).
+
+## Setup
+
+After starting the application, you can access the web interface and log in with the default credentials:
+
+-   **Email**: `admin@example.com`
+-   **Password**: `changeme`
+
+You will be prompted to change the password after your first login.

pgadmin/README.md

@@ -0,0 +1,16 @@
+# pgAdmin
+
+pgAdmin is a popular open-source graphical user interface (GUI) tool for managing and administering PostgreSQL databases. It provides a user-friendly web-based interface to interact with both local and remote PostgreSQL servers.
+
+[pgAdmin Website](https://www.pgadmin.org/)
+
+## How to start
+
+1.  Create a `.env` file based on the `.env.example` file.
+2.  Set the `USERNAME`, `PASSWORD`, and `PGADMIN_DATA` variables in the `.env` file.
+3.  Run `docker-compose up -d` to start the application.
+4.  The application will be available at [http://localhost:8888](http://localhost:8888).
+
+## Setup
+
+After starting the application, you can access the web interface and log in with the credentials you provided in the `.env` file.

portainer/.env

@@ -1,2 +1,2 @@
-# Path where thr Portainer data will be stored on the host
+# Path where the Portainer data will be stored on the host
 PORTAINER_DATA=${PORTAINER_DATA}

portainer/README.md

@@ -0,0 +1,16 @@
+# Portainer
+
+Portainer is a lightweight, open-source tool that provides a graphical user interface (GUI) to simplify the management of containerized environments. It is designed to make working with containers more accessible, especially for those who may not be comfortable with the command-line interface (CLI).
+
+[Portainer Website](https://www.portainer.io/)
+
+## How to start
+
+1.  Create a `.env` file based on the `.env.example` file.
+2.  Set the `PORTAINER_DATA` variable in the `.env` file.
+3.  Run `docker-compose up -d` to start the application.
+4.  The application will be available at [https://localhost:9443](https://localhost:9443).
+
+## Setup
+
+After starting the application, you can access the web interface and create a new admin user. You can then connect to your Docker environment and start managing your containers.

seafile/README.md

@@ -0,0 +1,22 @@
+# Seafile
+
+Seafile is an open-source, cross-platform file hosting and synchronization software system. It allows you to store files on a central server and access them from personal computers and mobile devices. Functionally similar to Dropbox or Google Drive, the primary difference is that Seafile is designed to be self-hosted, giving users more control over their data and infrastructure.
+
+[Seafile Website](https://www.seafile.com/)
+
+## Services
+
+-   **seafile**: The main Seafile application.
+-   **db**: A MariaDB database for Seafile.
+-   **memcached**: A Memcached server for caching.
+
+## How to start
+
+1.  Create a `.env` file based on the `.env.example` file.
+2.  Set the environment variables in the `.env` file.
+3.  Run `docker-compose up -d` to start the application.
+4.  The application will be available at [http://localhost](http://localhost).
+
+## Setup
+
+After starting the application, you can access the web interface and log in with the credentials you provided in the `.env` file.

transmission/haugene-openvpn/README.md

@@ -1,4 +1,16 @@
-Please read the documentation first!
+# Transmission with OpenVPN (haugene/transmission-openvpn)
-https://haugene.github.io/docker-transmission-openvpn/
+
-
+This directory contains the configuration for the `haugene/transmission-openvpn` Docker image. This image bundles the Transmission BitTorrent client with an OpenVPN client, which ensures that all of Transmission's traffic is routed through a VPN tunnel, enhancing privacy and security.
-Compose file is set to use NordVPN, change the provider if needed and also comment out NordVPN country variable.
+
+[GitHub Repository](https://github.com/haugene/docker-transmission-openvpn)
+
+## How to start
+
+1.  Create a `.env` file based on the `.env.example` file.
+2.  Set the environment variables in the `.env` file, including your VPN provider and credentials.
+3.  Run `docker-compose up -d` to start the application.
+4.  The Transmission web interface will be available at [http://localhost:9091](http://localhost:9091).
+
+## Setup
+
+After starting the application, you can access the Transmission web interface to manage your torrents. The OpenVPN client will automatically connect to your VPN provider.

transmission/lscr.io/README.md

@@ -0,0 +1,16 @@
+# Transmission (lscr.io/linuxserver/transmission)
+
+This directory contains the configuration for the `lscr.io/linuxserver/transmission` Docker image. This image provides the Transmission BitTorrent client.
+
+[LinuxServer.io Website](https://www.linuxserver.io/)
+
+## How to start
+
+1.  Create a `.env` file based on the `.env.example` file.
+2.  Set the environment variables in the `.env` file.
+3.  Run `docker-compose up -d` to start the application.
+4.  The Transmission web interface will be available at [http://localhost:9091](http://localhost:9091).
+
+## Setup
+
+After starting the application, you can access the Transmission web interface to manage your torrents.

vaultwarden/README.md

@@ -0,0 +1,16 @@
+# Vaultwarden
+
+Vaultwarden is a free and open-source password manager that is an alternative implementation of the Bitwarden server. It is written in the Rust programming language and is designed to be lightweight and efficient, making it suitable for running on low-powered devices like a Raspberry Pi. Formerly known as Bitwarden_RS, Vaultwarden is not associated with Bitwarden, Inc.
+
+[Vaultwarden GitHub](https://github.com/dani-garcia/vaultwarden)
+
+## How to start
+
+1.  Create a `.env` file based on the `.env.example` file.
+2.  Set the `DOMAIN` and `PATH_TO_DATA` variables in the `.env` file.
+3.  Run `docker-compose up -d` to start the application.
+4.  The application will be available at the domain you specified in the `.env` file.
+
+## Setup
+
+After starting the application, you can access the web interface and create a new user. You can then use the official Bitwarden clients to connect to your self-hosted server.

webtop/README.md

@@ -0,0 +1,16 @@
+# Webtop
+
+`linuxserver/webtop` is a Docker image that provides a full Linux desktop environment accessible through a web browser. It's designed to be a lightweight and convenient way to run a Linux desktop without needing to install a full operating system on your machine.
+
+[LinuxServer.io Website](https://docs.linuxserver.io/images/docker-webtop)
+
+## How to start
+
+1.  Create a `.env` file based on the `.env.example` file.
+2.  Set the `PATH_TO_CONFIG` variable in the `.env` file.
+3.  Run `docker-compose up -d` to start the application.
+4.  The application will be available at [http://localhost:3000](http://localhost:3000).
+
+## Setup
+
+After starting the application, you can access the web interface and use the Linux desktop environment.