You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
StephanSainleger 62a3948f5d Merge pull request 'maj master' (#1) from 0k/0k-charms:master into master 11 months ago
apache fix: dev: removed ``--force-yes`` everywhere as it is deprecated 1 year ago
bitwarden new: [bitwarden] upgrade to ``1.22.2``. 1 year ago
cron fix: dev: removed ``--force-yes`` everywhere as it is deprecated 1 year ago
cyclos new: [cyclos] new database with more standardized payment types and bug fixes 1 year ago
cyclos-ui new: [cyclos-ui] new charm 2 years ago
docker-host new: [docker-host] set system timezone 4 years ago
docker-registry new: dev: [apache] store a ``url`` argument instead of a ``protocol`` argument. 4 years ago
docker-registry-auth new: [docker-registry-auth] allow usage of acl rules for public access. 3 years ago
drone new: [drone] add ``backup`` relation 2 years ago
drone-agent new: [drone-agent] implemented labels 4 years ago
etherpad fix: [etherpad] keep API key 1 year ago
gitea chg: [gitea] update to 1.14.2 1 year ago
gitlab new: [gitlab] new charm 4 years ago
gogocarto fix: [gogocarto] allow to follow redirection when downloading release 2 years ago
gogocartojs new: [gogocartojs] added charm 3 years ago
hedgedoc fix: [hedgedoc] fix upload of image and updatge to ``1.7.2`` 2 years ago
letsencrypt fix: [letsencrypt] wildcard domains would fail to be created 2 years ago
lo-xcgd new: [py3o-{fusion,server},lo-xcgd] add charm 3 years ago
logrotate chg: [logrotate] be more verbose 2 years ago
mariadb fix: [mariabd] bad typo would prevent dump to be made 1 year ago
mattermost fix: [mongo,odoo-tecnativa,mattermost,peertube,synapse,rocketchat,redis] avoid using ``find``'s ``-exec`` option as it fails 3 years ago
mongo new: [bitwarden,mongo,nextcloud,rocketchat] added backup relation 2 years ago
monujo new: [monujo] add charm 1 year ago
mysql fix: dev: removed ``--force-yes`` everywhere as it is deprecated 1 year ago
nextcloud new: [nextcloud] allow to override image locally 2 years ago
odoo-tecnativa new: [odoo-tecnativa] add ``install`` action to install module into database 1 year ago
onlyoffice chg: [onlyoffice] add backup to onlyoffice, relunctantly 1 year ago
peertube new: [peertube] update to v3.3.0 1 year ago
piwigo new: [piwigo] added ``backup`` relation. 2 years ago
postgres chg: [postgres] change ``backup`` relation from ``optional`` to is ``recommended`` 2 years ago
postgres-alpine new: ``charm`` and ``service`` are now clear distinct concept 4 years ago
precise fix: [docker-host] support fixing root SSL certificate for older hosts 12 months ago
py3o-fusion new: [py3o-{fusion,server},lo-xcgd] add charm 3 years ago
py3o-server new: [py3o-{fusion,server},lo-xcgd] add charm 3 years ago
radicale new: added ``radicale``. 5 years ago
rancher chg: [mattermost,odoo-tecnativa,rancher-agent,rancher,traefik] restart policy is now automatically set for non run-once services. 4 years ago
rancher-agent chg: [mattermost,odoo-tecnativa,rancher-agent,rancher,traefik] restart policy is now automatically set for non run-once services. 4 years ago
redis new: [apache,peertube,redis] added new backup relation 2 years ago
rocketchat chg: [rocketchat] update to version ``3.18.1`` 1 year ago
rsync-backup new: [rsync-backup] add ``compose.yml`` to backup 1 year ago
rsync-backup-target new: [rsync-backup-target] allow backup account to request a recovery key 1 year ago
searx new: [searx] add charm 2 years ago
sftp new: add doc to ``sftp`` charm 12 months ago
softether new: [softether] new charm. 6 years ago
synapse fix: [mongo,odoo-tecnativa,mattermost,peertube,synapse,rocketchat,redis] avoid using ``find``'s ``-exec`` option as it fails 3 years ago
traefik chg: [mattermost,odoo-tecnativa,rancher-agent,rancher,traefik] restart policy is now automatically set for non run-once services. 4 years ago
vsftp new: [vsftp] new charm 4 years ago
whoami new: [traefik,whoami] new charms 4 years ago chg: updated the README and changed to ``org`` format 2 years ago


This package provides charms, which are special system recipes, that are meant to be executable and mangled together to allow managing a wide set of services.

Inspired by juju charms, these are mostly bash scripts organized by service and meant to automate all administration tasks, from installation, to connection with other services, or any other task a service would need.

Several tools are able to read the current state of this repository to effectively deploy full production grade services on different type of platform.

The only real fully functional implementation is 0k-compose. It will use these charms to drive, prepare, and build in docker, complete sets of services.

Another old solution called lxc-deploy was used actively before to deploy services on LXC tool set until 2016 using these charms.

Bare hosts can also replay some recipes to install services directly on them via the 0k-charm project using the charm apply command. Note that actually, as most recipes are bash executable, it is still a viable option to copy-paste parts of source-code of these scripts. These last two options are still used very often to bootstrap installs of docker-hosts for instance.


Charms in these repository are in a wide set of maturity, from simple note taking of shell commands, not even executable, to full charm allowing to deploy services and manage the full life cycle of the service.

The repository in a whole is thus NOT considered as mature at all, and will require some thorough cleaning and decisions to furthermore structure to reach a state where it'll make sense to go full public.


TODO Through compose for full deployment of sets of services

Requires 0k-compose package that contains the compose command line tool.


TODO Through lxc-deploy for full install and deployment of services

Requires lxc-scripts package that holds several tools for LXC management, amongst them is lxc-deploy.


TODO Through docker-build-charm for docker image creation

Requires 0k-docker package that holds several tools for docker management, amongst them is docker-build-charm.

docker-build-charm will use the install recipes in a charm to basically mimic the Dockerfile purpose and create a docker image for a specific service.


TODO Through 0k-charm for bare hosts installs

Requires 0k-charm package to get the charm command line util.



Most tools should check the CHARM_STORE bash environment variable that should be the path to reach the root of this repository. If not defined, most tools will look in /srv/charm-store by default.