{"id":13405919,"url":"https://github.com/GhostWriters/DockSTARTer","last_synced_at":"2025-03-14T10:32:03.279Z","repository":{"id":37502767,"uuid":"134865462","full_name":"GhostWriters/DockSTARTer","owner":"GhostWriters","description":"DockSTARTer helps you get started with running apps in Docker.","archived":false,"fork":false,"pushed_at":"2024-04-13T04:34:58.000Z","size":28857,"stargazers_count":2134,"open_issues_count":19,"forks_count":223,"subscribers_count":47,"default_branch":"master","last_synced_at":"2024-04-13T21:57:11.672Z","etag":null,"topics":["debian","docker","docker-compose","homelab","htpc","raspbian","self-hosted","ubuntu"],"latest_commit_sha":null,"homepage":"https://dockstarter.com/","language":"Shell","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/GhostWriters.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null},"funding":{"open_collective":"DockSTARTer","github":"nemchik"}},"created_at":"2018-05-25T14:16:11.000Z","updated_at":"2024-04-15T11:21:36.199Z","dependencies_parsed_at":"2024-01-01T04:03:42.796Z","dependency_job_id":"ea3be44f-2b7f-4c49-b3a3-3af9a24c9074","html_url":"https://github.com/GhostWriters/DockSTARTer","commit_stats":{"total_commits":2392,"total_committers":83,"mean_commits":"28.819277108433734","dds":"0.43185618729096986","last_synced_commit":"8d6e7bf73ee2b0cc76c6a8a83168fe100f97f7db"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GhostWriters%2FDockSTARTer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GhostWriters%2FDockSTARTer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GhostWriters%2FDockSTARTer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GhostWriters%2FDockSTARTer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GhostWriters","download_url":"https://codeload.github.com/GhostWriters/DockSTARTer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221458257,"owners_count":16825278,"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":["debian","docker","docker-compose","homelab","htpc","raspbian","self-hosted","ubuntu"],"created_at":"2024-07-30T19:02:15.915Z","updated_at":"2025-03-14T10:32:03.264Z","avatar_url":"https://github.com/GhostWriters.png","language":"Shell","readme":"# \u003c!-- Home --\u003e\n\n[![DockSTARTer](https://github.com/GhostWriters/DockSTARTer/raw/master/docs/assets/logo.png)](https://dockstarter.com)\n\n[![Supporters on Open Collective](https://img.shields.io/opencollective/all/DockSTARTer.svg?style=flat-square\u0026color=607D8B\u0026logo=opencollective\u0026logoColor=white)](#supporters)\n[![Discord chat](https://img.shields.io/discord/477959324183035936.svg?style=flat-square\u0026color=607D8B\u0026logo=discord\u0026logoColor=white)](https://dockstarter.com/discord)\n[![GitHub contributors](https://img.shields.io/github/contributors/GhostWriters/DockSTARTer.svg?style=flat-square\u0026color=607D8B\u0026logo=github\u0026logoColor=white)](https://github.com/GhostWriters/DockSTARTer/graphs/contributors)\n[![GitHub last commit master](https://img.shields.io/github/last-commit/GhostWriters/DockSTARTer/master.svg?style=flat-square\u0026color=607D8B\u0026logo=github\u0026logoColor=white\u0026label=code%20committed)](https://github.com/GhostWriters/DockSTARTer/commits/master)\n[![GitHub license](https://img.shields.io/github/license/GhostWriters/DockSTARTer.svg?style=flat-square\u0026color=607D8B\u0026logo=github\u0026logoColor=white)](https://github.com/GhostWriters/DockSTARTer/blob/master/LICENSE)\n[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/GhostWriters/DockSTARTer/tests.yml?style=flat-square\u0026color=607D8B\u0026logo=github\u0026logoColor=white\u0026branch=master)](https://github.com/GhostWriters/DockSTARTer/actions?query=workflow%3ARun%20Tests+branch%3Amaster)\n\nThe main goal of DockSTARTer is to make it quick and easy to get up and running with Docker.\n\nYou may choose to rely on DockSTARTer for various changes to your Docker system or use DockSTARTer as a stepping stone and learn to do more advanced configurations.\n\n![Main Menu](https://i.imgur.com/odfRk0j.png)\n\n![App Select](https://i.imgur.com/tFsu2Hh.png)\n\n![Value Prompt](https://i.imgur.com/k1bdAoQ.png)\n\n![Command Line Interface](https://i.imgur.com/Y8F3uT2.png)\n\n## Getting Started\n\n### System Requirements\n\n- You must be running a [supported platform](https://docs.docker.com/install/#supported-platforms) or an operating system based on a supported platform. Platforms named below will link to documentation listing compatible versions.\n- You must be logged in as a non-root user with sudo permissions.\n\n### One Time Setup (required)\n\n- APK Systems (Alpine)\n\n  ```bash\n  sudo apk add curl git\n  bash -c \"$(curl -fsSL https://get.dockstarter.com)\"\n  sudo reboot\n  ```\n\n- APT Systems ([Debian](https://docs.docker.com/install/linux/docker-ce/debian/#os-requirements), [Ubuntu](https://docs.docker.com/install/linux/docker-ce/ubuntu/#os-requirements), etc)\n\n  ```bash\n  sudo apt-get install curl git\n  bash -c \"$(curl -fsSL https://get.dockstarter.com)\"\n  sudo reboot\n  ```\n\n  \u003e Raspbian requires a few extra commands\n\n  ```bash\n  sudo apt-get update\n  sudo apt-get dist-upgrade\n  sudo apt-get install curl git\n  bash -c \"$(curl -fsSL https://get.docker.com)\"\n  bash -c \"$(curl -fsSL https://get.dockstarter.com)\"\n  sudo reboot\n  ```\n\n  \u003e OpenMediaVault (OMV) requires [special instructions found here](https://dockstarter.com/advanced/openmediavault/)\n\n- DNF Systems ([Fedora](https://docs.docker.com/install/linux/docker-ce/fedora/#os-requirements))\n\n  ```bash\n  sudo dnf install curl git\n  bash -c \"$(curl -fsSL https://get.dockstarter.com)\"\n  sudo reboot\n  ```\n\n- Pacman Systems (Arch, Manjaro, EndeavourOS, etc.)\n\n  ```bash\n  sudo pacman -Sy curl docker git\n  bash -c \"$(curl -fsSL https://get.dockstarter.com)\"\n  sudo reboot\n  ```\n\n- YUM Systems ([CentOS](https://docs.docker.com/install/linux/docker-ce/centos/#os-requirements))\n\n  ```bash\n  sudo yum install curl git\n  bash -c \"$(curl -fsSL https://get.dockstarter.com)\"\n  sudo reboot\n  ```\n\n\u003cdetails\u003e\n  \u003csummary\u003eAlternate install (any system)\u003c/summary\u003e\n\nThe standard install above downloads the initial script using a method with some known risks. For those concerned with the security of the above method, here is an alternative:\n\n```bash\n## NOTE: Run the appropriate command for your distro\nsudo apt-get install curl git\nsudo dnf install curl git\nsudo pacman -Sy curl git\nsudo yum install curl git\n```\n\nThen\n\n```bash\ngit clone https://github.com/GhostWriters/DockSTARTer \"/home/${USER}/.docker\"\nbash /home/\"${USER}\"/.docker/main.sh -vi\nsudo reboot\n```\n\n\u003c/details\u003e\n\n### Running DockSTARTer\n\n```bash\nds\n```\n\nTo run DockSTARTer, use the command above. You should now see the main menu from the screenshots. Select `Configuration` and then `Full Setup`, and you will be guided through selecting apps and starting containers.\n\nSee our [documentation](https://dockstarter.com/introduction/) for more detailed information.\n\n## Support\n\n[![Discord chat](https://img.shields.io/discord/477959324183035936.svg?style=flat-square\u0026color=607D8B\u0026logo=discord)](https://dockstarter.com/discord)\n\nClick the chat badge to join us on Discord for support!\n\n[Feature Request](https://github.com/GhostWriters/DockSTARTer/issues/new?template=feature_request.md) | [Bug Report](https://github.com/GhostWriters/DockSTARTer/issues/new?template=bug_report.md)\n\nAdditional information can be found on our [Support Page](https://dockstarter.com/basics/support/).\n\n## Contributing\n\nWant to help develop DockSTARTer? Check out our [contributing guidelines](https://github.com/GhostWriters/DockSTARTer/blob/master/.github/CONTRIBUTING.md) and [code of conduct](https://github.com/GhostWriters/DockSTARTer/blob/master/.github/CODE_OF_CONDUCT.md).\n\n### Contributors\n\n[![GitHub contributors](https://img.shields.io/github/contributors/GhostWriters/DockSTARTer.svg?style=flat-square\u0026color=607D8B)](https://github.com/GhostWriters/DockSTARTer/graphs/contributors)\n\nThis project exists thanks to all the people who contribute.\n[![GitHub contributors](https://opencollective.com/DockSTARTer/contributors.svg?button=false)](https://GitHub.com/GhostWriters/DockSTARTer/graphs/contributors)\n\n## Supporters\n\nSupport the project by donating on [Open Collective](https://opencollective.com/DockSTARTer#donation).\n\n### Backers\n\n[![Backers on Open Collective](https://img.shields.io/opencollective/tier/DockSTARTer/7408.svg?style=flat-square\u0026color=607D8B\u0026label=backers)](https://opencollective.com/DockSTARTer#backer)\n\nThank you to all our backers! [Become a backer](https://opencollective.com/DockSTARTer#backer).\n\n[![Backers on Open Collective](https://opencollective.com/DockSTARTer/tiers/backer.svg)](https://opencollective.com/DockSTARTer#backers)\n\n### Sponsors\n\n[![Sponsors on Open Collective](https://img.shields.io/opencollective/tier/DockSTARTer/7409.svg?style=flat-square\u0026color=607D8B\u0026label=sponsors)](https://opencollective.com/DockSTARTer#sponsor)\n\nSupport this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor](https://opencollective.com/DockSTARTer#sponsor).\n\n[![Sponsors on Open Collective](https://opencollective.com/DockSTARTer/tiers/sponsor/0/avatar.svg)](https://opencollective.com/DockSTARTer/tiers/sponsor/0/website)\n[![Sponsors on Open Collective](https://opencollective.com/DockSTARTer/tiers/sponsor/1/avatar.svg)](https://opencollective.com/DockSTARTer/tiers/sponsor/1/website)\n[![Sponsors on Open Collective](https://opencollective.com/DockSTARTer/tiers/sponsor/2/avatar.svg)](https://opencollective.com/DockSTARTer/tiers/sponsor/2/website)\n[![Sponsors on Open Collective](https://opencollective.com/DockSTARTer/tiers/sponsor/3/avatar.svg)](https://opencollective.com/DockSTARTer/tiers/sponsor/3/website)\n[![Sponsors on Open Collective](https://opencollective.com/DockSTARTer/tiers/sponsor/4/avatar.svg)](https://opencollective.com/DockSTARTer/tiers/sponsor/4/website)\n[![Sponsors on Open Collective](https://opencollective.com/DockSTARTer/tiers/sponsor/5/avatar.svg)](https://opencollective.com/DockSTARTer/tiers/sponsor/5/website)\n[![Sponsors on Open Collective](https://opencollective.com/DockSTARTer/tiers/sponsor/6/avatar.svg)](https://opencollective.com/DockSTARTer/tiers/sponsor/6/website)\n[![Sponsors on Open Collective](https://opencollective.com/DockSTARTer/tiers/sponsor/7/avatar.svg)](https://opencollective.com/DockSTARTer/tiers/sponsor/7/website)\n[![Sponsors on Open Collective](https://opencollective.com/DockSTARTer/tiers/sponsor/8/avatar.svg)](https://opencollective.com/DockSTARTer/tiers/sponsor/8/website)\n[![Sponsors on Open Collective](https://opencollective.com/DockSTARTer/tiers/sponsor/9/avatar.svg)](https://opencollective.com/DockSTARTer/tiers/sponsor/9/website)\n\n## Special Thanks\n\n- [SmartHomeBeginner.com](https://www.smarthomebeginner.com) for creating [AtoMiC-ToolKit](https://github.com/htpcBeginner/AtoMiC-ToolKit) that served as this project's primary inspiration, and later [this](https://www.smarthomebeginner.com/docker-home-media-server-2018-basic/) guide that provided some initial direction with Docker.\n- [LinuxServer.io](https://www.linuxserver.io) for maintaining most Docker images used in this project.\n","funding_links":["https://opencollective.com/DockSTARTer","https://github.com/sponsors/nemchik","https://opencollective.com/DockSTARTer/tiers"],"categories":["Shell","Container Operations","HarmonyOS","Apps","Torrenting","ubuntu"],"sub_categories":["User Interface","Windows Manager","Container","Seedboxes"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FGhostWriters%2FDockSTARTer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FGhostWriters%2FDockSTARTer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FGhostWriters%2FDockSTARTer/lists"}