{"id":23207099,"url":"https://github.com/aitorllj93/domus","last_synced_at":"2025-08-19T02:33:31.351Z","repository":{"id":208086521,"uuid":"720787695","full_name":"aitorllj93/domus","owner":"aitorllj93","description":"The Docker Cloud Operating System for your home","archived":false,"fork":false,"pushed_at":"2023-12-01T23:29:19.000Z","size":3276,"stargazers_count":6,"open_issues_count":2,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-06T16:28:48.937Z","etag":null,"topics":["docker","domus","home-cloud","home-server","iot","media-center","raspberry-pi","self-hosted"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aitorllj93.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}},"created_at":"2023-11-19T15:51:56.000Z","updated_at":"2024-12-28T18:39:21.000Z","dependencies_parsed_at":"2023-11-19T17:23:52.646Z","dependency_job_id":"f31f3c43-d867-4e77-9d0a-f8d13e89f073","html_url":"https://github.com/aitorllj93/domus","commit_stats":null,"previous_names":["aitorllj93/domus"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/aitorllj93/domus","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aitorllj93%2Fdomus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aitorllj93%2Fdomus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aitorllj93%2Fdomus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aitorllj93%2Fdomus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aitorllj93","download_url":"https://codeload.github.com/aitorllj93/domus/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aitorllj93%2Fdomus/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271090175,"owners_count":24697529,"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","status":"online","status_checked_at":"2025-08-19T02:00:09.176Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","domus","home-cloud","home-server","iot","media-center","raspberry-pi","self-hosted"],"created_at":"2024-12-18T17:17:43.345Z","updated_at":"2025-08-19T02:33:30.868Z","avatar_url":"https://github.com/aitorllj93.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Domus\n\n![Domus Screenshot](https://raw.githubusercontent.com/aitorllj93/domus/main/docs/assets/screenshots/heimdall-launcher.png)\n\nDomus is a highly opitionated distribution of docker-compose files to deploy a home server with a single command.\n\n## Features\n\nSome of the features included are:\n\n### Administration\n\n- [Portainer](https://www.portainer.io/) for managing the containers.\n- [Homarr](https://github.com/ajnart/homarr) for the dashboard/admin panel.\n- [Heimdall](https://heimdall.site/) for the home page.\n\n### Productivity\n\n- [Shiori](https://github.com/go-shiori/shiori) for bookmarks.\n- [Paperless](paperless-ngx.com) for documents.\n- [Mealie](https://mealie.io/) for recipes and meal planning.\n- [Home Assistant](https://www.home-assistant.io/) for home automation.\n\n### Entertainment\n\n- [Plex](https://www.plex.tv/) for media streaming.\n- [Calibre Web](https://github.com/janeczku/calibre-web) for ebooks and comics.\n- [Audiobookshelf](https://www.audiobookshelf.org) for audiobooks and podcasts.\n\n## Pre-requisites\n\n- [Docker](https://docs.docker.com/get-docker/)\n- [Docker Compose](https://docs.docker.com/compose/install/)\n- [Node.js \u003e=18.16.0](https://nodejs.org/en/download/)\n\n## Running Setup\n\n```sh\nnpx @central-factory/domus\n# or\nnpm i -g @central-factory/domus\ndomus\n```\n\n## Installing Applications\n\nYou can pass the -a flag to the setup command to directly install a set of applications.\n\n```sh\ndomus -a Books,Audiobooks\n```\n\n## Custom Setup\n\nFirst of all, you need a copy of this repository.\n\n```sh\nnpx degit aitorllj93/domus my-domus\ncd my-domus\nnpm install\nnpm link\n```\n\nYou can modify the templates in `portainer/templates` folder to fit your needs.\nYou can also customize the default applications to install in `lib/node/constants.js`.\n\nThen, you can run the setup with:\n\n```sh\ndomus\n```\n\n## Specification\n\nDomus encourages some patterns found in other similar projects such as [CasaOS](https://github.com/IceWhaleTech/CasaOS) to make the setup and integrations as easy as possible.\n\n### Docker Compose\n\nThe docker-compose files are located in the `portainer/templates` folder. Each service has its own folder with the `docker-compose.yml` file and optionally a `data` folder for the persistent data.\n\n#### docker-compose.yml\n\nThe docker-compose file is a standard docker-compose file with some extra features under the `x-domus` keys.\n\n### Volumes\n\nAll the volumes are mounted under the `/DATA` folder in the host machine.\n\n#### Config \u0026 Databases\n\nConfig and databases are stored in the `/DATA/AppData` folder, with the name of the service as the folder name.\n\n#### Media\n\nMedia is stored in the `/DATA/Media` folder, and structured based on the type of media.\n\n- `/DATA/Media/Audiobooks`\n- `/DATA/Media/Books`\n- `/DATA/Media/Documents`\n- `/DATA/Media/Movies`\n- `/DATA/Media/Music`\n- `/DATA/Media/Podcasts`\n- `/DATA/Media/TV Shows`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faitorllj93%2Fdomus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faitorllj93%2Fdomus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faitorllj93%2Fdomus/lists"}