This is the home server of Santosma. It is a server that runs on a Raspberry Pi 4 and is used for various purposes. The server is running on a Raspberry Pi 4 with 4GB of RAM and a 64GB SD card. The server is running on Ubuntu Server.
The following steps were taken to set up the server:
- Install Ubuntu Server on the Raspberry PI.
- Setup a static IP address and SSH access.
- Configure the machine with Ansible.
- Setup GitHub SSH.
- Clone this repository to the server.
- Create the necessary credentials files. See the Credentials section for more information.
- Run the
docker-compose up -dcommand to start the services.
This system is using the following credentials:
backups-encryption.key: The encryption key for the backups. You can generate a new key using theopenssl rand -base64 256 > backups-encryption.keycommand. Make sure to keep this key secure and do not lose it, as it is required to decrypt the backups..env: The environment file that contains the environment variables for the services. This file is not included in the repository for security reasons. You can create this file by copying the.env.examplefile and updating the values as needed.
On the scripts folder there are some scripts to help with the management of the server. The scripts are:
clean-backups.sh: Clean the backups older than 30 days. This script is used by the backups service to clean old backups.create-backup.sh: Create a backup of the services volumes, compress, encrypt and upload to Mega. This script is used by the backups service to create recurring backups.restore-backup.sh: Download, decrypt, decompress and restore the backups.
The server is running the following services:
| Service | Container Name | External Ports | Internal Ports |
|---|---|---|---|
| FreshRSS | freshrss | N/A | 80 |
| RSS Bridge | rssbridge | N/A | 80 |
| instagram-feed-generator | instagram-feed-generator | N/A | 80 |
| rss-nginx | freshrss-nginx | 8000 | 80 |
| Vaultwarden | vaultwarden | 8100 | 80 |
| Uptime Kuma | uptime-kuma | 3001 | |
| Docker Socket Proxy | dockerproxy | N/A | 2375 |
| Cloudflared | cloudflared | N/A | N/A |
| Backups | backups | N/A | N/A |
FreshRSS is a free, self-hosted RSS feed reader. It is a great way to keep up with your favorite websites and blogs.
RSS Bridge is a PHP project that allows you to generate RSS feeds for websites that do not have them. It is a great way to keep up with websites that do not offer RSS feeds.
instagram-feed-generator is my own implementation to generate an RSS feed from an Instagram account. It is a great way to keep up with your favorite Instagram accounts without having to use the Instagram app.
An nginx server that serves all the services related to RSS feeds. It is used to serve the FreshRSS and RSS Bridge services.
This is serving the following services:
- FreshRSS:
http://rss-nginx:80/ - RSS Bridge:
http://rss-nginx:80/rss-bridge - instagram-feed-generator:
http://rss-nginx:80/instagram-feed-generator
Vaultwarden is a free, open-source password manager that is compatible with Bitwarden. It is a great way to store and manage your passwords securely.
Uptime Kuma is a self-hosted monitoring tool that checks the uptime of your websites and services.
Docker Socket Proxy is a tool that allows you to securely access the Docker API from a remote machine. It is used by Portainer to access the Docker API on the host machine.
Cloudflared is a tool that allows you to tunnel traffic through Cloudflare's network. Is used to access to the local server from the internet.
This service is my own implementation to backup the data from all others services volumes. The backups are encrypted using the backups-encryption.key file and uploaded to Mega using the mega-cmd tool. Also, this service remove old backups from the local server to save space.