{"id":13632810,"url":"https://github.com/osixia/docker-openldap-backup","last_synced_at":"2025-03-16T19:32:02.507Z","repository":{"id":35233420,"uuid":"39492802","full_name":"osixia/docker-openldap-backup","owner":"osixia","description":"A docker image to run OpenLDAP, and make periodic backups 🐳","archived":false,"fork":false,"pushed_at":"2021-08-19T12:17:56.000Z","size":77,"stargazers_count":99,"open_issues_count":10,"forks_count":43,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-02-27T12:37:59.408Z","etag":null,"topics":["backup","docker","docker-image","openldap"],"latest_commit_sha":null,"homepage":"","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/osixia.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-07-22T07:45:06.000Z","updated_at":"2025-01-11T01:51:03.000Z","dependencies_parsed_at":"2022-09-16T15:20:17.739Z","dependency_job_id":null,"html_url":"https://github.com/osixia/docker-openldap-backup","commit_stats":null,"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osixia%2Fdocker-openldap-backup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osixia%2Fdocker-openldap-backup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osixia%2Fdocker-openldap-backup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osixia%2Fdocker-openldap-backup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/osixia","download_url":"https://codeload.github.com/osixia/docker-openldap-backup/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243826792,"owners_count":20354220,"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":["backup","docker","docker-image","openldap"],"created_at":"2024-08-01T22:03:16.525Z","updated_at":"2025-03-16T19:32:02.198Z","avatar_url":"https://github.com/osixia.png","language":"Shell","funding_links":[],"categories":["Shell"],"sub_categories":[],"readme":"# osixia/openldap-backup\n\n[![Docker Pulls](https://img.shields.io/docker/pulls/osixia/openldap-backup.svg)][hub]\n[![Docker Stars](https://img.shields.io/docker/stars/osixia/openldap-backup.svg)][hub]\n[![](https://images.microbadger.com/badges/image/osixia/openldap-backup.svg)](http://microbadger.com/images/osixia/openldap-backup \"Get your own image badge on microbadger.com\")\n\n[hub]: https://hub.docker.com/r/osixia/openldap-backup/\n\nLatest release: 1.5.0 - [Changelog](CHANGELOG.md) | [Docker Hub](https://hub.docker.com/r/osixia/openldap-backup/) \n\n**A docker image to run OpenLDAP, and make periodic backups.**\n\n- [osixia/openldap-backup](#osixiaopenldap-backup)\n\t- [Contributing](#contributing)\n\t- [Quick start](#quick-start)\n\t\t- [Backup directory and data persistence](#backup-directory-and-data-persistence)\n\t\t- [Debug](#debug)\n\t- [Environment Variables](#environment-variables)\n\t\t- [Set your own environment variables](#set-your-own-environment-variables)\n\t\t\t- [Use command line argument](#use-command-line-argument)\n\t\t\t- [Link environment file](#link-environment-file)\n\t\t\t- [Make your own image or extend this image](#make-your-own-image-or-extend-this-image)\n\t- [Advanced User Guide](#advanced-user-guide)\n\t\t- [Extend osixia/openldap-backup:1.5.0 image](#extend-osixiaopenldap-backup150-image)\n\t\t- [Make your own openldap-backup image](#make-your-own-openldap-backup-image)\n\t\t- [Tests](#tests)\n\t\t- [Kubernetes](#kubernetes)\n\t\t- [Under the hood: osixia/openldap](#under-the-hood-osixiaopenldap)\n\t- [Security](#security)\n\t- [Changelog](#changelog)\n\n## Contributing\n\nIf you find this image useful here's how you can help:\n\n- Send a pull request with your kickass new features and bug fixes\n- Help new users with [issues](https://github.com/osixia/docker-openldap-backup/issues) they may encounter\n- Support the development of this image and star this repo !\n\n## Quick start\n\nThis image is based on osixia/openldap please refer to:\n[https://github.com/osixia/docker-openldap](https://github.com/osixia/docker-openldap) \n\nHere just the backup extension will be described.\n\n### Backup directory and data persistence\n\nBackups are created in the directory `/data/backup` that should be mapped has volume so your ldap files are saved outside the container.\n\n      docker run --env LDAP_BACKUP_CONFIG_CRON_EXP=\"0 5 * * *\" \\\n      --volume /data/openldap/backup:/data/backup \\\n      --detach osixia/openldap-backup:1.5.0\n\n\nFor more information about docker data volume, please refer to :\n\n\u003e [https://docs.docker.com/userguide/dockervolumes/](https://docs.docker.com/userguide/dockervolumes/)\n\n### Debug\n\nThe container default log level is **info**.\nAvailable levels are: `none`, `error`, `warning`, `info`, `debug` and `trace`.\n\nExample command to run the container in `debug` mode:\n\n\tdocker run --detach osixia/openldap-backup:1.5.0 --loglevel debug\n\nSee all command line options:\n\n\tdocker run osixia/openldap-backup:1.5.0 --help\n\n\n## Environment Variables\n\nEnvironment variables defaults are set in **image/environment/default.yaml**.\n\nSee how to [set your own environment variables](#set-your-own-environment-variables)\n\n- **LDAP_BACKUP_CONFIG_CRON_EXP**: Cron expression to schedule OpenLDAP config backup. Defaults to `0 4 * * *`. Every days at 4am.\n\n- **LDAP_BACKUP_DATA_CRON_EXP**: Cron expression to schedule OpenLDAP data backup. Defaults to `0 4 * * *`. Every days at 4am.\n\n- **LDAP_BACKUP_TTL**: Backup TTL in days. Defaults to `15`.\n\n\n### Set your own environment variables\n\n#### Use command line argument\nEnvironment variables can be set by adding the --env argument in the command line, for example:\n\n    docker run --env LDAP_BACKUP_CONFIG_CRON_EXP=\"0 5 * * *\" \\\n    --detach osixia/openldap-backup:1.5.0\n\n\n#### Link environment file\n\nFor example if your environment file is in :  /data/ldap/environment/my-env.yaml\n\n\tdocker run --volume /data/ldap/environment/my-env.yaml:/container/environment/01-custom/env.yaml \\\n\t--detach osixia/openldap-backup:1.5.0\n\nTake care to link your environment file to `/container/environment/XX-somedir` (with XX \u003c 99 so they will be processed before default environment files) and not  directly to `/container/environment` because this directory contains predefined baseimage environment files to fix container environment (INITRD, LANG, LANGUAGE and LC_CTYPE).\n\n#### Make your own image or extend this image\n\nThis is the best solution if you have a private registry. Please refer to the [Advanced User Guide](#advanced-user-guide) just below.\n\n## Advanced User Guide\n\n### Extend osixia/openldap-backup:1.5.0 image\n\nIf you need to add your custom environment files you can extends this image.\n\nDockerfile example:\n\n\tFROM osixia/openldap-backup:1.5.0\n\tMAINTAINER Your Name \u003cyour@name.com\u003e\n\n\tADD environment /container/environment/01-custom\n\n\n### Make your own openldap-backup image\n\nClone this project:\n\n\tgit clone https://github.com/osixia/docker-openldap-backup\n\tcd docker-openldap-backup\n\nAdapt Makefile, set your image NAME and VERSION, for example:\n\n\tNAME = osixia/openldap-backup\n\tVERSION = 1.1.9\n\n\tbecome:\n\tNAME = cool-guy/openldap-backup\n\tVERSION = 0.1.0\n\nAdd environment files...\n\nBuild your image:\n\n\tmake build\n\nRun your image:\n\n\tdocker run --detach cool-guy/openldap-backup:0.1.0\n\n### Tests\n\nWe use **Bats** (Bash Automated Testing System) to test this image:\n\n\u003e [https://github.com/sstephenson/bats](https://github.com/sstephenson/bats)\n\nInstall Bats, and in this project directory run:\n\n\tmake test\n\n### Kubernetes\n\nKubernetes is an open source system for managing containerized applications across multiple hosts, providing basic mechanisms for deployment, maintenance, and scaling of applications.\n\nMore information:\n- http://kubernetes.io\n- https://github.com/kubernetes/kubernetes\n\nosixia-openldap-backup kubernetes examples are available in [osixia/docker-openldap](https://github.com/osixia/docker-openldap/tree/stable/example/kubernetes/simple).\n\n### Under the hood: osixia/openldap\n\nThis image is based on osixia/openldap.\nMore info: https://github.com/osixia/docker-openldap\n\n## Security\nIf you discover a security vulnerability within this docker image, please send an email to the Osixia! team at security@osixia.net. For minor vulnerabilities feel free to add an issue here on github.\n\nPlease include as many details as possible.\n\n## Changelog\n\nPlease refer to: [CHANGELOG.md](CHANGELOG.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fosixia%2Fdocker-openldap-backup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fosixia%2Fdocker-openldap-backup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fosixia%2Fdocker-openldap-backup/lists"}