old-adapdr/apps-server

A container based home development server, just copy over dist.* files, set the .env and get rolling!

Home (development) Server

Open-source fueled apps, services and tools for a self hosting & development.

Overview

The templates are grouped into three types:

• core: Required core services to deploy & manage other services
• services: Single service templates
• stacks: Multi-service templates

Core

• gateway | traefik: Container native proxy & service gateway
• admin | portainer: Container native monitoring and administration interface

Services:

• vault | vaultwarden: Open-source rust implementation of the password manager bitwarden
• storage | minio: Open-source object storage
• automations | n8n: Open-source integration & flow based automation tool
• registry: Docker container registry
• ctc: Container Test Case to confirm deployment & letsencrypt certificate generation

Stacks:

• ci | drone: Open-source CI/CD pipeline and deployment powered by community integrations
• cloud | nextcloud: Open-source GCloud/Dropbox alternative
• writeups | ghost: Open-source publication tool and wordpress alternative
• analytics | matomo: Open-source GDPR compliant analytics platform

W.I.P.

• deploy: A generalized way to auto-deploy new verified updates (Either via script alone or together with TerraForm)
• backups: A generalized way to backup and manage the system
• logs & metrics: A generalized way to view and manage logs (Prometheus)
• security: A generalized way to scan the deployed VLANs and services for malicious activity. (TemplarBit?)

Setup

Requirements

• Note all DOMAIN variables are without HTTP(S) prefix!

  • Valid domain: vault.hs.example.com
  • Invalid doman: https://vault.hs.example.com

• DNS A record with a wildcard sub.domain.tld pointing towards the server

• Domain & global storage .env variables are required for the gateway and letsencrypt to work

• A server with at least 2 core CPU and 4GB of RAM

  • Note: Start-up may require more RAM or slow-down with only 2 cores/CPUs
  • Note: Varies depending on load, usage and number of services currently running
  • Note: Once deployed, all current services requires ~2.1GB of RAM

Configuration & Deployment

The gateway detects and auto-adds new services as they're deployed so it should be deployed first with either option!

Automatic deployment

• New and improved auto-deploy to be added in the future =)

Manual deployment

1. Copy dist.env and dist.docker-compose.yml files for core with your preferred configuration
2. Pull and start core services with docker-compose up from the service directory and verify that they're running (with letsencrypt provided SSL certs)
3. Copy dist.env and dist.docker-compose.yml files for your preferred service/stack setup
4. Pull and start preferred services with docker-compose up -d from the serviec directory.

apps-server's Issues

Add generic deployment alternative

There should be an alternative or option to auto-deploy to a generic VPS as a target. A good generic choice might be a DigitalOcean droplet?

This way it can be tested, used and otherwise utilized as open-source by other developers.

Fix deployment permissions error

Deployment overwrites permissions on the deploy.py file, the drone-service need to be updated to have rwx for the target folder

Add better setup instructions

Right now it's not necessarily clear or user-friendly to setup HS. This can be addressed by updating and extending the README.md documentation.

Rename

Repository should be renamed to better explain what it does and avoid over-abriviation.

Improved deployment options

Would be great to have improved deployment options included.

This can be implemented in several ways, but a good starting point may be:

• Preset supplied by setup.py
• Config file added for setup.py with a list of what to install
• Users can tweak config.extension to add/remove/update various images

This would also allow for global settings to be used for shared environment variables (domain, storage, etc)

Add docker container registry to HS

A docker container registry should be added to the HS development environment. This way public containers can be kept to "release only" reducing the amount of time required to manage that pipeline & flow.

Write follow-up post on [alexpdr/hs](https://github.com/alexpdr/hs) for [alexpdr.com](https://www.alexpdr.com)

Set up HS board

Cards & automations needs to be configured for the HS board

Update traefik to automatically redirect http->https

Update is required for traefik to automatically redirect http->https for all docker discovered services

Deploy

Needs to be deployed to the server

Auto-deployment updates

Auto-deployment needs to be tested and made (even more) generic to avoid blockers and issues with later additions.

In particular storage needs a new/rewritten solution to allow generic targets further down the line.

Update and/or replace deploy.py

Update and/or replace deploy.py as it's currently not working.

BAAS Stack redis doesn't work with supplied credentials

BAAS Stack redis doesn't work with supplied credentials

Could possibly be caused by default conflicting with provided?