{"id":23011919,"url":"https://github.com/chriamue/home-server","last_synced_at":"2025-10-19T23:58:18.730Z","repository":{"id":118702588,"uuid":"87389136","full_name":"chriamue/home-server","owner":"chriamue","description":"Docker containers for a small server environment.","archived":false,"fork":false,"pushed_at":"2024-09-14T15:58:00.000Z","size":72,"stargazers_count":13,"open_issues_count":1,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-12-13T18:09:23.983Z","etag":null,"topics":["docker","docker-compose","gitlab","jenkins","ldap","nextcloud","nginx","server"],"latest_commit_sha":null,"homepage":null,"language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chriamue.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-04-06T05:21:20.000Z","updated_at":"2024-09-14T15:58:04.000Z","dependencies_parsed_at":null,"dependency_job_id":"f1082b29-7fb9-4e87-aa73-2d7fbd4b7859","html_url":"https://github.com/chriamue/home-server","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chriamue%2Fhome-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chriamue%2Fhome-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chriamue%2Fhome-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chriamue%2Fhome-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chriamue","download_url":"https://codeload.github.com/chriamue/home-server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229805132,"owners_count":18126808,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","docker-compose","gitlab","jenkins","ldap","nextcloud","nginx","server"],"created_at":"2024-12-15T10:11:53.365Z","updated_at":"2025-10-19T23:58:18.660Z","avatar_url":"https://github.com/chriamue.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# home-server\nDocker containers for a small server environment.\n\nThis project aims to provide Docker configurations for a small server environment. It's primarily a personal documentation effort and may not be production-ready. It is maintained on an as-needed basis, meaning updates might be infrequent. However, it's open to anyone who wants a starting point or to learn more about creating a Docker-based server environment.\n\n![deployment diagram](https://www.plantuml.com/plantuml/proxy?cache=no\u0026src=https://raw.githubusercontent.com/chriamue/home-server/master/deployment.puml)\n\n## Supported Services\n\n* [gitlab](https://en.wikipedia.org/wiki/GitLab)\n* [nextcloud](https://en.wikipedia.org/wiki/Nextcloud)\n* [traefik](https://en.wikipedia.org/wiki/Traefik)\n* whoami - A simple container that responds with its container ID, useful for testing load balancing and proxying.\n* kanidm - A modern, secure and fast identity management platform.\n* vaultwarden - An unofficial Bitwarden compatible server written in Rust.\n* vpn - WireGuard VPN for secure networking.\n* plantuml - A tool for creating UML diagrams from a plain text language.\n* openldap - OpenLDAP software for Lightweight Directory Access Protocol.\n\nThe users will be managed using [ldap](https://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol).\n\n## Installing Portainer\n\n[Portainer](https://www.portainer.io/) is a lightweight management UI which allows you to easily manage your Docker host or Swarm cluster. It is particularly useful when setting up a home server environment as it provides a visual interface to manage Docker containers.\n\nTo install Portainer, you can use the following Docker command:\n\n```bash\ndocker volume create portainer_data\ndocker run -d -p 9443:9443 --name portainer --restart=always -v /var/run/docker.sock:/var/run/docker.sock -v portainer_data:/data portainer/portainer-ce:2.19.3\n```\n\nThis will pull the latest Portainer image from Docker Hub, create a new volume for storing data, and start a new container. The Portainer UI can then be accessed by navigating to http://\u003cyour-server-ip\u003e:9443.\n\nFor more detailed instructions, refer to the [official Portainer documentation](https://docs.portainer.io).\n\n## Quick Start\n\nClone repository:\n\n```git clone https://github.com/chriamue/home-server```\n\nChange into source directory:\n\n```cd home-server```\n\nCreate your own branch:\n\n```git checkout -b configbranch```\n\nEdit compose for your needs:\n\n```cp example.env .env```\n\n```vim .env```\n\n```vim docker-compose.yml```\n\nCommit your changes:\n\n```git commit -m 'updated docker-compose.yml'```\n\nBuild and download docker images:\n\n```docker-compose build```\n\nStart portainer only:\n\n```docker-compose up -d --profile portainer portainer```\n\nRun docker compose:\n\n```docker-compose up -d```\n\nStop docker compose:\n\n```docker-compose stop```\n\n## restart server\n\nAfter a reboot you have to restart the services manually.\nStart them in following order.\n\n```bash\ndocker-compose restart openldap\ndocker-compose restart ldapaccountmanager\ndocker-compose restart gitlab\ndocker-compose restart nextcloud-db\ndocker-compose restart nextcloud\ndocker-compose restart traefik\n```\n\n## update git repo\n\n```bash\ngit pull\ngit merge master\n```\n\n## Upgrade services\n\nStop SERVICE:\n\n```docker-compose stop SERVICE```\n\nRemove old SERVICE:\n\n```docker-compose rm SERVICE```\n\nChange to subfolder of SERVICE.\nEdit the Dockerfile.\nChange version number.\nStart new SERVICE:\n\n```docker-compose up -d SERVICE```\n\n## Tips\n\nTo test locally change `127.0.0.1 localhost jenkins.localhost lam.localhost gitlab.localhost`\nin your /etc/hosts file.\n\n### btrfs\n\nUse a btrfs filesystem.\nCreate a subvolume for data persistence.\n\n```bash\ncd /\nsudo btrfs subvolume create srv\n```\n\n### renew your certificates\n\nAdd ```--expand``` to certbot command in docker-compose.yml file.\n\n```bash\ndocker-compose stop\ndocker-compose run --rm -p 80:80 -p 443:443 certbot\ndocker-compose start ...\n```\n\n### upgrade gitlab\n\nIf you have problems upgrading gitlab, try this:\n\n```bash\ndocker run -P -ti -v /srv/data/var/lib/gitlab:/var/opt/gitlab -v /srv/data/etc/gitlab:/etc/gitlab -v /srv/data/var/log/gitlab:/var/log/gitlab --rm gitlab/gitlab-ce bash\n```\n\nInside container run:\n\n```bash\nupdate-permissions\n/opt/gitlab/embedded/bin/runsvdir-start \u0026 sleep 10 \u0026\u0026 gitlab-ctl reconfigure\n```\n\n## [lam](ldap-account-manager/README.md) (ldap account manager)\n\nOpen ldap account manager in browser: [http://lam.localhost]()\n\n## [Gitlab](gitlab/README.md)\n\nOpen Gitlab in browser: [http://gitlab.localhost]()\n\n## [Nextcloud](nextcloud/README.md)\n\nOpen Nextcloud in browser: [http://nextcloud.localhost]()\n\n## [Nginx](nginx/README.md)\n\nWeb server here used as proxy to the services.\n\n## [cloudflared](cloudflared/README.md)\n\nArgo tunnel as alternative to nginx proxy.\n\n## [OpenLDAP](openldap/README.md)\n\n## [backup](backup/README.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchriamue%2Fhome-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchriamue%2Fhome-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchriamue%2Fhome-server/lists"}