Please note, that DB\_MYSQL\_\* environment variables will take precedent over DB\_SQLITE\_\* variables. So if you keep the MySQL variables, you will not be able to use SQLite. #
This installation guide is for NPM with MariaDB (MySQL). ##### Using MariaDB Database with NPM If you opt for the MariaDB configuration you will have to provide the database server yourself. The current minimum supported version is: - MariaDB v10.2.7+ It's easy to use another docker container for your database also and link it as part of the docker stack, so that's what the following examples are going to use. Here is my `docker-compose.yml` using a MariaDB container. You can use it as example : ```yaml version: '3' services: app: image: 'jc21/nginx-proxy-manager:latest' ports: - '80:80' - '81:81' - '443:443' environment: DB_MYSQL_HOST: "db" DB_MYSQL_PORT: 3306 DB_MYSQL_USER: "your MySQL username" DB_MYSQL_PASSWORD: "your MySQL password" DB_MYSQL_NAME: "nginx" TZ: America/New_York volumes: - /localpathtoyourNPMdata:/data - /localpathtoyourNPMletsencryptcertificatedata:/etc/letsencrypt db: image: 'mariadb' environment: MYSQL_ROOT_PASSWORD: 'your MySQL root password' MYSQL_DATABASE: 'nginx' MYSQL_USER: 'your MySQL username' MYSQL_PASSWORD: 'your MySQL password' TZ: America/New_York volumes: - /localpathtoyourNPMdatabase:/var/lib/mysql ```Make sure you change DB\_MYSQL\_USER, DB\_MYSQL\_PASSWORD and MYSQL\_ROOT\_PASSWORD to whatever username and passwords you intend to use.
Make sure you change the local path of your volumes to the path you intend to use to store NGINX Proxy Manager data, certificates and the database.
Also, make sure you change the timezone (TZ) parameter to reflect your timezone as it affects the certificate timestamps you get from Let's Encrypt. You can find your timezone from here: [Wikipedia TZ Database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
# Uptime Kuma ###  **[Uptime Kuma](https://github.com/louislam/uptime-kuma) is a self-hosted, open source, fancy uptime monitoring and alerting system. It can monitor HTTP, HTTP with keyword, TCP, Ping, and DNS systems.** Uptime Kuma is an easy way to know if your systems are up and running. You can even add your favorite Internet sites (i.e., Facebook, Amazon, Twitter, etc.) if you want to be sure they are working. I use Uptime Kuma primarily for my home LAN components and any websites/applications I host from home. Uptime Kuma even permits me to provide status pages for my users so they can know at a glance if any of my services are down or under maintenance.  In addition, you can setup any number of ways to be notified if any monitored service becomes unavailable. Uptime Kuma supports notifications via email, SMS and more. I currently use Telegram for notifications from Kuma to my phone.As Kuma also supports [**Apprise**](https://github.com/caronc/apprise) (which supports 50+ notification methods by itself), I will likely move to that notification platform in the future.
 --- #### Installation There are both stand-alone and container installation methods for Uptime Kuma. I chose the container method as I am heavily invested in Docker and Docker-Compose on my systems. To install via Docker, use the following code for the default values. ```shell docker run -d --restart=always -p 3001:3001 -v uptime-kuma:/app/data --name uptime-kuma louislam/uptime-kuma:1 ``` Otherwise, you can specify your port and data storage (volume) using this docker template. ```shell docker run -d --restart=always -pShell instructions.
```shell mkdir uptime-kuma cd uptime-kuma touch docker-compose.yml nano docker-compose.yml # copy the contents from the docker-compose.yml example below mkdir data ls docker-compose up -d --force-recreate ```Docker compose file contents. This goes in the docker-compose.yml file you created above.
```yaml --- version: "3.1" services: uptime-kuma: image: louislam/uptime-kuma:1 container_name: uptime-kuma volumes: -Make sure you replace <Uptime Kuma data volume> with the path on your local machine that you want to save your Kuma configuration and data files. For example, /var/lib/docker/volumes/uptime-kuma
Also make sure you change <Uptime Kuma port> to whatever port you want to use. The default port is 3001. I use the default port because it doesn't conflict with any other software on the system where I have Kuma installed. Your system may be different.
So, as an example, if you wanted to use the path and port as listed above, your docker-compose.yml would look like this: ```yaml --- version: "3.1" services: uptime-kuma: image: louislam/uptime-kuma:1 container_name: uptime-kuma volumes: - /var/lib/docker/volumes/uptime-kuma:/app/data ports: - 3001:3001 restart: unless-stopped security_opt: - no-new-privileges:true ``` #### Accessing Uptime Kuma Once you have started your Uptime Kuma container, you should now be able to access from a browser by going to http://<your server IP>:<your port> where **<your server ip>** is the IP address of the server where you installed Uptime Kuma and **<your port>** is the port you chose to use in the docker-compose.yml file. So if your server's IP address is 192.168.1.10 and you chose port 3001, the URL for your browser should look like: http://192.168.1.10:3001 #### Updating Uptime Kuma When a new version of Uptime Kuma becomes available, you will see  appear at the top right of your Uptime Kuma dashboard. Clicking this will take you to the Uptime Kuma Github page where you can see what changes have been made to the new version. If you installed Uptime Kuma using Docker or Docker-Compose (not stand-alone) you may not yet be able to update your instance until the image is built. This is explicitly stated on the [Kuma Update](https://github.com/louislam/uptime-kuma/wiki/%F0%9F%86%99-How-to-Update) page... > For every new release, it takes some time to build the docker image, please be patient if it is not available yet I currently use [**Watchtower**](https://bookstack.timshome.net/books/home-server-applications/page/watchtower) to monitor and automatically update all my Docker images. If you do not have some method installed to automate updating your Docker images you may use the excellent instructions provided by the Uptime Kuma author to [manually update your Uptime Kuma container](https://github.com/louislam/uptime-kuma/wiki/%F0%9F%86%99-How-to-Update). # GoAccess ### GoAccess Web Server Statistics  **GoAccess** is an open source **real-time** **web log analyzer** and interactive viewer that runs in a **terminal** in \*nix systems or through your **browser**. It provides **fast** and valuable HTTP statistics for system administrators that require a visual server report on the fly. I use GoAccess to monitor my self-hosted websites traversing my reverse proxy and Cloudflare. --- #### Installation GoAccess installation methods can be found by going to the **[official GoAccess website](https://goaccess.io/get-started)** I use a Docker image specifically designed for GoAccess to pull logs from an instance of **[Nginx Proxy Manager](https://bookstack.timshome.net/books/home-server-applications/page/nginx-proxy-manager).** If you have that setup, then this is my recommended Docker Compose file setup. ```yaml version: '3.3' services: goaccess: image: 'xavierh/goaccess-for-nginxproxymanager:latest' container_name: goaccess restart: always ports: - '7880:7880' environment: - TZ=America/New_York - SKIP_ARCHIVED_LOGS=False #optional - DEBUG=False #optional - BASIC_AUTH=False #optional - BASIC_AUTH_USERNAME=user #optional - BASIC_AUTH_PASSWORD=pass #optional - EXCLUDE_IPS=127.0.0.1 #optional - comma delimited - LOG_TYPE=NPM #optional - more information below volumes: - /path-to-your-nginxproxymanager/logs:/opt/log - /path/to/host/custom:/opt/custom #optional, required if using log_type = CUSTOM ```Be sure to replace "/path-to-your-nginxproxymanager/logs" with your actual path to your Nginx Proxy Manager logs. This docker-compose.yml also assumes port 7880 is available on your server. If not, change to an available port of your choosing.
Explanations of the "optional" portions of the docker compose file can be found by going to [**the Docker image author's Github repository**](https://github.com/xavier-hernandez/goaccess-for-nginxproxymanager). # Productivity Applications Reference information for client/server productivity applications # Bookstack  [**BookStack**](https://www.bookstackapp.com/) is a simple, self-hosted, easy-to-use platform for organising and storing information. I rebranded my Bookstack instance to [**MyWiki**](https://bookstack.timshome.net/) and originally intended to use it only for my personal reference and possibly some journalling. I still use it for referencing but I am building it out as a "knowledge-base library" so others may benefit. If you're here, you probably figured that out already 🙂  --- #### Installation To install Bookstack, you will need Docker installed at a minimum and optimally Docker Compose as well. This installation guide assumes you are installing Bookstack on Ubuntu 22.04 and you have both Docker and Docker Compose installed. If you do not have Docker and Docker Compose installed, you can follow my guides for doing so by clicking these links: - [**How to install Docker**](https://bookstack.timshome.net/books/home-server-applications/page/docker) - [**How to install Docker Compose**](https://bookstack.timshome.net/books/home-server-applications/page/docker-compose)You don't have to install Bookstack using containers. It's just my preference. You can see all the installation methods by going to [**Bookstack's official installation web page**](https://www.bookstackapp.com/docs/admin/installation/#other).
I am using a pre-built container from [**LinuxServer.io**](https://github.com/linuxserver/docker-bookstack/pkgs/container/bookstack). You gain access to the relevant container images via a Docker Compose YAML file. You will need to edit various parameters to configure Bookstack and your Bookstack database. Container images are configured using parameters passed at runtime. These parameters are separated by a colon and indicate `Go [**HERE**](https://en.m.wikipedia.org/wiki/List_of_tz_database_time_zones "Timezone Database Environment Variables") to find your timezone
- Change DB\_USER and MYSQL\_USER to whatever you want, but both need to be the same user OR you can leave both as 'bookstack'. - Change DB\_PASS and MYSQL\_PASSWORD to a long, strong password. Both variables need to match one another. - Under the volumes section, change '/path/to/data' to the path of the directory where you will store your Bookstack configuration data.Make sure the user and group you specified in your PUID & GUID has read and write permissions to the path and directory you specify.
- You can also change the port you will use to access Bookstack. The default port is 6875. You really only need to change this if that port is already in use on the computer on which you are installing Bookstack. Once you have your docker-compose.yml configured and saved, you can start your Bookstack instance by typing: ``` docker compose up -d ``` or, if using an older version of Docker Compose: ``` docker-compose up -d ```You must run the command from the directory where you saved your docker-compose.yml file.
#### Access to Bookstack From a web browser on the computer where you installed Bookstack, enter the following URL: [http://localhost:6875](http://localhost:6875)If you changed the default port from 6875 to something else, you will need to specify it in your URL
If you are on a different computer than the one where you installed bookstack. change *localhost* to reflect the IP address or domain name of the computer where Bookstack is installed. # Mealie  [**Mealie**](https://mealie.io/) is a self hosted recipe manager and meal planner with a RestAPI backend and a reactive frontend application built in Vue for a pleasant user experience for the whole family. Easily add recipes into your database by providing the url and Mealie will automatically import the relevant data or add a family recipe with the UI editor. Mealie also provides an API for interactions from 3rd party applications.  #### Key Features - 🔍 Fuzzy search - 🏷️ Tag recipes with categories or tags to flexible sorting - 🕸 Import recipes from around the web by URL - 📱 Progressive Web App - 📆 Create Meal Plans - 🛒 Generate shopping lists - 🐳 Easy setup with Docker - 🎨 Customize your interface with color themes layouts - 💾 Export all your data in any format with Jinja2 Templates, with easy data restoration from the user interface. - 🌍 localized in many languages - ➕ Plus tons more! - Flexible API - Custom key/value pairs for recipes - Webhook support - Interactive API Documentation - Raw JSON Recipe Editor - Migration from other platforms - Chowdown - Nextcloud Cookbook - Random meal plan generation --- # NextCloud  [**Nextcloud**](https://nextcloud.com/) is the industry-leading, fully open-source, on-premises (self-hosted) content collaboration platform. Teams access, share and edit their documents, chat and participate in video calls and manage their mail and calendar and projects across mobile, desktop and web interfaces. Hub integrates the four key Nextcloud products Files, Talk, Groupware and Office into a single platform, optimizing the flow of collaboration. Eliminate the confusing hodgepodge of different SaaS tools and the compliance, security, cost and productivity issues that come with it and standardize on a single solution with Nextcloud Hub. --- # Vaultwarden  [**Vaultwarden**](https://github.com/dani-garcia/vaultwarden) is an alternative self-hosted implementation of Bitwarden. It is compatible with all [upstream Bitwarden clients](https://bitwarden.com/download/) Bitwarden is an open-source password management service that stores sensitive information such as website credentials in an encrypted vault. The platform offers a variety of client applications including a web interface, desktop applications, browser extensions, mobile apps, and a command-line interface. --- #### Installation Pull the docker image and mount a volume from the host for persistent storage: ```shell docker pull vaultwarden/server:latest docker run -d --name vaultwarden -v /vw-data/:/data/ -p 80:80 vaultwarden/server:latest ``` Change `/vw-data/` to the path where you will store your vaultwarden data locally. Change the port if you are already using port 80 for another service on the installation computer. For example, from `80:80` to `8181:80` If you are installing on a Linux server, you can verify what ports are in use by using this command ```shell sudo ss -ltn ```It is highly recommended to secure your Vaultwarden server using a TLS certificate. If you have an available domain name, you can get HTTPS certificates with [Let's Encrypt](https://letsencrypt.org/), or you can generate self-signed certificates with utilities like [mkcert](https://github.com/FiloSottile/mkcert). Some proxies automate getting certificates, like [**NGINX Proxy Manager**](https://bookstack.timshome.net/books/home-server-applications/page/nginx-proxy-manager).
--- #### Accessing Vaultwarden ##### Browser To access your Vaultwarden server from a web browser, locally `http://localhost:port`[ ](http://localhost)where 'localhost' is the IP address of your Vaultwarden server and 'port' is the port number you defined in your docker container if it is any port other than port 80. You should see a screen similar to this:  You will need to create an account to use it. Just click the 'Create account' link on the page.It is also worth noting that you can export your current Bitwarden data (if you already had a Bitwarden account) directly into Vaultwarden by using any Bitwarden client's 'Export Vault' function while logged with your Bitwarden account. You can export into .json or csv formats. You then log out of your Bitwarden account and and login using your Vaultwarden account on that same client and import your data using the 'Import Vault' function. Your data will then automatically sync to any other Bitwarden client where you have your Vaultwarden account set up.
--- #### Clients You can access you Vaultwarden server using any of the clients supported by Bitwarden. To set your Bitwarden clients to point to your Vaultwarden server, follow these instructions: ##### Browser Extension or Mobile App To connect a browser extension or mobile app to your Vaultwarden server: 1. Log out of your Bitwarden browser extension or mobile app. 2. On the login screen, select the [](https://bookstack.timshome.net/uploads/images/gallery/2023-04/gZTZXDCrtAcsOL6R-screenshot-from-2023-04-09-08-15-50.png) **Settings** icon. 3. In the **Server URL** field, enter the domain name for your server with `https://` (for example, `https://my.bitwarden.domain.com`). 4. Select **Save**.You must have your Vaultwarden server setup with a domain name and a TLS or self-signed certificate for this to work
##### Desktop Client Each account that's logged in to your desktop app can be connected to a different server. For example, you can have one account that connects to a Bitwarden server in the cloud and another account that connects to a private Vaultwarden server. To connect your desktop client to point to your Vaultwarden server: 1. Log out of your account in your Bitwarden desktop app **OR** select **+** **Add Account**. 2. On the login screen, select the [](https://bookstack.timshome.net/uploads/images/gallery/2023-04/gZTZXDCrtAcsOL6R-screenshot-from-2023-04-09-08-15-50.png) **Settings** icon. 3. In the **Server URL** field, enter the domain name for your server with `https://` (for example, `https://my.bitwarden.domain.com`). 4. Select **Save**. # Container Applications Containerization is a form of virtualization where applications run in isolated user spaces, called containers, while using the same shared operating system (OS). One of the benefits of containerization is that a container is essentially a fully packaged and portable computing environment. A container is standard unit of software that packages up code and all its dependencies so the application runs quickly and reliably from one computing environment to another. This chapter details the container management software I currently use to manage containerized applications. # Docker  **[Docker](https://www.docker.com/)** is an application that simplifies the process of managing application processes in *containers*. Containers let you run your applications in resource-isolated processes. They’re similar to virtual machines, but containers are more portable, more resource-friendly, and more dependent on the host operating system. --- #### Installation In this guide, you will install Docker Community Edition (CE) on Ubuntu 22.04. To follow this tutorial, you will need the following: - One Ubuntu 22.04 server, including a `sudo` non-**root** user and a firewall. - An account on [**Docker Hub**](https://hub.docker.com/) if you wish to create your own images and push them to Docker Hub. The Docker installation package available in the official Ubuntu repository may not be the latest version. To ensure we get the latest version, we’ll install Docker from the official Docker repository. To do that, we’ll add a new package source, add the GPG key from Docker to ensure the downloads are valid, and then install the package. First, update your existing list of packages: ```shell sudo apt update ``` Next, install a few prerequisite packages which let `apt` use packages over HTTPS: ```shell sudo apt install apt-transport-https ca-certificates curl software-properties-common ``` Then add the GPG key for the official Docker repository to your system: ```shell curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg ``` Add the Docker repository to APT sources: ```shell echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null ``` Update your existing list of packages again for the addition to be recognized: ```shell sudo apt update ``` Make sure you are about to install from the Docker repo instead of the default Ubuntu repo: ```shell apt-cache policy docker-ce ``` You’ll see output like this, although the version number for Docker may be different:**Note:** Starting with Docker Compose v2, Docker has migrated towards using the `compose` CLI plugin command, and away from the original `docker-compose`. The actual usage involves dropping the hyphen from `docker-compose` calls to become `docker compose`
1\. Use the following command to download v2.16.0: ```shell mkdir -p ~/.docker/cli-plugins/ curl -SL https://github.com/docker/compose/releases/download/v2.16.0/docker-compose-linux-x86_64 -o ~/.docker/cli-plugins/docker-compose ```If the version has changed since this guide was written, simply replace "2.16.0" in the command above with the new version number.
2\. Set the correct permissions so that the `docker compose` command is executable: ```shell chmod +x ~/.docker/cli-plugins/docker-compose ``` 3\. Verify that the installation was successful by running the following: ```shell docker compose version ``` The terminal should return the version of Docker Compose you selected. # Portainer  **Portainer Community Edition** is a lightweight service delivery platform for containerized applications that can be used to manage Docker, Swarm, Kubernetes and ACI environments. It is designed to be as simple to deploy as it is to use. The application allows you to manage all your orchestrator resources (containers, images, volumes, networks and more) through a ‘smart’ GUI and/or an extensive API. Portainer consists of a single container that can run on any cluster. It can be deployed as a Linux container or a Windows native container. --- #### Introduction Portainer consists of two elements, the *Portainer Server*, and the *Portainer Agent*. Both elements run as lightweight Docker containers on a Docker engine. This document will help you install the Portainer Server container on your Linux environment. To add a new Linux environment to an existing Portainer Server installation, please refer to the **Portainer Agent Installation** section of this guide.By default, Portainer generates and uses a self-signed SSL certificate to secure port `9443`. Alternatively you can provide your own SSL certificate during installation or via the Portainer UI after installation.
If you require HTTP port `9000` open for legacy reasons, the following to your `docker run` command: **add -p 9000:9000**
Portainer Server has now been installed. You can check to see whether the Portainer Server container has started by running: ```shell docker ps ``` If all is well, you should see container is Up ```yaml root:~# docker ps CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES de5b28eb2fa9 portainer/portainer-ce:latest "/portainer" 2 weeks ago Up 9 days 0.0.0.0:8000->8000/tcp, :::8000->8000/tcp, 0.0.0.0:9443->9443/tcp, :::9443->9443/tcp portainer ``` #### Logging In Now that the installation is complete, you can log into your Portainer Server instance by opening a web browser and going to: ```shell https://localhost:9443 ```You need to run an instance of Watchtower on each server where you run Docker containers.
**Follow these steps to get Watchtower up and running:** - Make a directory for your Watchtower project and then navigate into it: ```shell mkdir ~/watchtower cd ~/watchtower ``` - Create a new YAML file named `docker-compose.yml` using `nano` or your preferred text editor: ```shell nano docker-compose.yml ``` - Insert the following into `docker-compose.yml`: ```yaml version: "3" services: watchtower: container_name: watchtower image: containrrr/watchtower volumes: - /var/run/docker.sock:/var/run/docker.sock restart: unless-stopped environment: - TZ=America/New_York - WATCHTOWER_LIFECYCLE_HOOKS=1 # Enable pre/post-update scripts command: --debug true --cleanup true dockerimage1 dockerimage2 dockerimage3 ``` Where "dockerimage" 1, 2, and 3 are the names of the docker images I want to monitor and update when a change occurs to the original image.Make sure to put a "space" between the names of the images you want to monitor
- Save and exit your file. If you used `nano`, you can do this by pressing`CTRL+O`, `ENTER`, then `CTRL+X`. Now you can start your containers using `docker compose up`. Add the `-d` flag to prevent Docker from taking over your terminal: ```shell docker compose up -d ```Passing a list of containers to monitor, which does not include the watchtower container, will disable the monitoring of watchtower. By adding it to the argument list, it will start automatically updating itself.