Harbormaster
============
Do you have apps you want to deploy to a server, but Kubernetes is way too much?
Harbormaster is for you.
Harbormaster is a small and simple container orchestrator that lets you easily deploy
multiple Docker-Compose applications on a single host.
It does this by taking a list of git repository URLs that contain Docker
Compose files and running the Compose apps they contain. It will also handle
updating/restarting the apps when the repositories change.
Please [visit the documentation](https://harbormaster.readthedocs.io/en/latest/) for
more details.
## Rationale
Do you have a home server you want to run a few apps on, but don't want everything to
break every time you upgrade the OS? Do you want automatic updates but don't want to buy
an extra 4 servers so you can run Kubernetes?
Do you have a work server that you want to run a few small services on, but don't want
to have to manually manage it? Do you find that having every deployment action be in
a git repo more tidy?
Harbormaster is for you.
At its core, Harbormaster takes a YAML config file with a list of git repository URLs
containing Docker Compose files, clones/pulls them, and starts the services they
describe.
You run Harbormaster on a timer, pointing it to a directory, and it updates all the
repositories in its configuration, and restarts the Compose services if they have
changed. That's it!
It also cleanly stores data for all apps in a single `data/` directory, so you always
have one directory that holds all the state, which you can easily back up and restore.
See more details in [the documentation](https://harbormaster.readthedocs.io/en/latest/).
# Changelog
## v0.3.4 (2023-07-31)
### Features
* Add the `HM_` vars to the environment so they can be used in Compose v2 files. [Stavros Korokithakis]
### Fixes
* Fix wrong paths when launching Docker Compose. [Stavros Korokithakis]
## v0.3.3 (2023-07-23)
### Fixes
* Add missing crond invocation back. [Stavros Korokithakis]
* Don't complain about the directory if we restart the container. [Stavros Korokithakis]
## v0.3.2 (2023-07-23)
### Fixes
* Fix tests. [Stavros Korokithakis]
* Fix the Harbormaster Docker container. [Stavros Korokithakis]
* Fix issue with the Harbormaster Docker image not being able to find the data dir. [Stavros Korokithakis]
* Add docker-cli-compose to the Dockerfile. [Stavros Korokithakis]
## v0.3.1 (2023-07-22)
### Features
* Add git-crypt to the Docker image. [Stavros Korokithakis]
### Fixes
* Change Compose filename. [Stavros Korokithakis]
* Don't restart apps when their configuration hasn't been updated. [葛上昌司]
* Move the --version command to the right place. [Stavros Korokithakis]
## v0.3.0 (2023-03-01)
### Features
* Add docker image with webhook support. [Jonas Seydel]
### Fixes
* Upgrade Click (fixes #9) [Stavros Korokithakis]
* Be more defensive when loading the config. [Stavros Korokithakis]
* Fix the configuration directory having the wrong relative path base (fixes #12) [Stavros Korokithakis]
Raw data
{
"_id": null,
"home_page": "https://harbormaster.readthedocs.io/en/latest/",
"name": "docker-harbormaster",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4",
"maintainer_email": "",
"keywords": "",
"author": "Stavros Korokithakis",
"author_email": "hi@stavros.io",
"download_url": "https://files.pythonhosted.org/packages/01/f1/3ac6af35b599d5c9c3f05addb9e65bd8280aa68b20ddeea373f6f0bcee24/docker_harbormaster-0.3.4.tar.gz",
"platform": null,
"description": "Harbormaster\n============\n\nDo you have apps you want to deploy to a server, but Kubernetes is way too much?\nHarbormaster is for you.\n\nHarbormaster is a small and simple container orchestrator that lets you easily deploy\nmultiple Docker-Compose applications on a single host.\n\nIt does this by taking a list of git repository URLs that contain Docker\nCompose files and running the Compose apps they contain. It will also handle\nupdating/restarting the apps when the repositories change.\n\nPlease [visit the documentation](https://harbormaster.readthedocs.io/en/latest/) for\nmore details.\n\n\n## Rationale\n\nDo you have a home server you want to run a few apps on, but don't want everything to\nbreak every time you upgrade the OS? Do you want automatic updates but don't want to buy\nan extra 4 servers so you can run Kubernetes?\n\nDo you have a work server that you want to run a few small services on, but don't want\nto have to manually manage it? Do you find that having every deployment action be in\na git repo more tidy?\n\nHarbormaster is for you.\n\nAt its core, Harbormaster takes a YAML config file with a list of git repository URLs\ncontaining Docker Compose files, clones/pulls them, and starts the services they\ndescribe.\n\nYou run Harbormaster on a timer, pointing it to a directory, and it updates all the\nrepositories in its configuration, and restarts the Compose services if they have\nchanged. That's it!\n\nIt also cleanly stores data for all apps in a single `data/` directory, so you always\nhave one directory that holds all the state, which you can easily back up and restore.\n\nSee more details in [the documentation](https://harbormaster.readthedocs.io/en/latest/).\n\n# Changelog\n\n\n## v0.3.4 (2023-07-31)\n\n### Features\n\n* Add the `HM_` vars to the environment so they can be used in Compose v2 files. [Stavros Korokithakis]\n\n### Fixes\n\n* Fix wrong paths when launching Docker Compose. [Stavros Korokithakis]\n\n\n## v0.3.3 (2023-07-23)\n\n### Fixes\n\n* Add missing crond invocation back. [Stavros Korokithakis]\n\n* Don't complain about the directory if we restart the container. [Stavros Korokithakis]\n\n\n## v0.3.2 (2023-07-23)\n\n### Fixes\n\n* Fix tests. [Stavros Korokithakis]\n\n* Fix the Harbormaster Docker container. [Stavros Korokithakis]\n\n* Fix issue with the Harbormaster Docker image not being able to find the data dir. [Stavros Korokithakis]\n\n* Add docker-cli-compose to the Dockerfile. [Stavros Korokithakis]\n\n\n## v0.3.1 (2023-07-22)\n\n### Features\n\n* Add git-crypt to the Docker image. [Stavros Korokithakis]\n\n### Fixes\n\n* Change Compose filename. [Stavros Korokithakis]\n\n* Don't restart apps when their configuration hasn't been updated. [\u845b\u4e0a\u660c\u53f8]\n\n* Move the --version command to the right place. [Stavros Korokithakis]\n\n\n## v0.3.0 (2023-03-01)\n\n### Features\n\n* Add docker image with webhook support. [Jonas Seydel]\n\n### Fixes\n\n* Upgrade Click (fixes #9) [Stavros Korokithakis]\n\n* Be more defensive when loading the config. [Stavros Korokithakis]\n\n* Fix the configuration directory having the wrong relative path base (fixes #12) [Stavros Korokithakis]\n\n\n\n",
"bugtrack_url": null,
"license": "AGPL-3.0-or-later",
"summary": "A supervisor for docker-compose apps.",
"version": "0.3.4",
"project_urls": {
"Homepage": "https://harbormaster.readthedocs.io/en/latest/",
"Repository": "https://gitlab.com/stavros/harbormaster"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e5c5ab58560f787b1c5614d72e22995d2b8242fd2c706ae356985221b1fba253",
"md5": "7ee5246b84807d987a7eed1f16cb3b01",
"sha256": "32814d2dfc188517dbb8ab626ed7bec7c251f98b2540d817da17505caaa3533b"
},
"downloads": -1,
"filename": "docker_harbormaster-0.3.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7ee5246b84807d987a7eed1f16cb3b01",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4",
"size": 24146,
"upload_time": "2023-07-31T21:29:22",
"upload_time_iso_8601": "2023-07-31T21:29:22.498262Z",
"url": "https://files.pythonhosted.org/packages/e5/c5/ab58560f787b1c5614d72e22995d2b8242fd2c706ae356985221b1fba253/docker_harbormaster-0.3.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "01f13ac6af35b599d5c9c3f05addb9e65bd8280aa68b20ddeea373f6f0bcee24",
"md5": "b8a3776d29f981a60db9b1d487660fab",
"sha256": "ca85e33f1b12670d061dd06f88dfa8679b62e2ca01cd83ff2e5da0c8b25c2489"
},
"downloads": -1,
"filename": "docker_harbormaster-0.3.4.tar.gz",
"has_sig": false,
"md5_digest": "b8a3776d29f981a60db9b1d487660fab",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4",
"size": 23694,
"upload_time": "2023-07-31T21:29:24",
"upload_time_iso_8601": "2023-07-31T21:29:24.005793Z",
"url": "https://files.pythonhosted.org/packages/01/f1/3ac6af35b599d5c9c3f05addb9e65bd8280aa68b20ddeea373f6f0bcee24/docker_harbormaster-0.3.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-31 21:29:24",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "stavros",
"gitlab_project": "harbormaster",
"lcname": "docker-harbormaster"
}
JSON