mirror of
https://github.com/semaphoreui/semaphore.git
synced 2024-11-27 02:52:14 +01:00
122 lines
5.5 KiB
Markdown
122 lines
5.5 KiB
Markdown
# Ansible Semaphore
|
|
|
|
[](https://twitter.com/semaphoreui)
|
|
[](https://snapcraft.io/semaphore)
|
|
[](https://stackshare.io/ansible-semaphore)
|
|
[](https://gitter.im/AnsibleSemaphore/semaphore?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
|
|
<!-- [](https://stackshare.io/ansible-semaphore) -->
|
|
<!-- [](https://godoc.org/github.com/ansible-semaphore/semaphore) -->
|
|
<!-- [](https://www.codacy.com/app/ansible-semaphore/semaphore?utm_source=github.com&utm_medium=referral&utm_content=ansible-semaphore/semaphore&utm_campaign=Badge_Grade)
|
|
[](https://www.codacy.com/app/ansible-semaphore/semaphore?utm_source=github.com&utm_medium=referral&utm_content=ansible-semaphore/semaphore&utm_campaign=Badge_Coverage) -->
|
|
|
|
Ansible Semaphore is a modern UI for Ansible. It lets you easily run Ansible playbooks, get notifications about fails, control access to deployment system.
|
|
|
|
If your project has grown and deploying from the terminal is no longer for you then Ansible Semaphore is what you need.
|
|
|
|
|
|
|
|
<!--
|
|
|
|
|
|
|
|
-->
|
|
|
|
|
|
<!--
|
|
- [Releases](https://github.com/ansible-semaphore/semaphore/releases)
|
|
- [Installation](https://docs.ansible-semaphore.com/administration-guide/installation)
|
|
- [Docker Hub](https://hub.docker.com/r/semaphoreui/semaphore/)
|
|
- [Contribution](https://github.com/ansible-semaphore/semaphore/blob/develop/CONTRIBUTING.md)
|
|
- [Troubleshooting](https://github.com/ansible-semaphore/semaphore/wiki/Troubleshooting)
|
|
- [Roadmap](https://github.com/ansible-semaphore/semaphore/projects)
|
|
- [UI Walkthrough](https://blog.strangeman.info/ansible/2017/08/05/semaphore-ui-guide.html) (external blog)
|
|
-->
|
|
|
|
## Installation
|
|
|
|
### Full documentation
|
|
https://docs.ansible-semaphore.com/administration-guide/installation
|
|
|
|
### Snap
|
|
|
|
```bash
|
|
sudo snap install semaphore
|
|
sudo semaphore user add --admin --name "Your Name" --login your_login --email your-email@examaple.com --password your_password
|
|
```
|
|
[](https://snapcraft.io/semaphore)
|
|
|
|
### Docker
|
|
|
|
`docker-compose.yml` for minimal configuration:
|
|
|
|
```yaml
|
|
services:
|
|
semaphore:
|
|
ports:
|
|
- 3000:3000
|
|
image: semaphoreui/semaphore:latest
|
|
environment:
|
|
SEMAPHORE_DB_DIALECT: bolt
|
|
SEMAPHORE_ADMIN_PASSWORD: changeme
|
|
SEMAPHORE_ADMIN_NAME: admin
|
|
SEMAPHORE_ADMIN_EMAIL: admin@localhost
|
|
SEMAPHORE_ADMIN: admin
|
|
volumes:
|
|
- /path/to/data/home:/etc/semaphore # config.json location
|
|
- /path/to/data/lib:/var/lib/semaphore # database.boltdb location (Not required if using mysql or postgres)
|
|
```
|
|
https://hub.docker.com/r/semaphoreui/semaphore
|
|
|
|
## Demo
|
|
|
|
You can test latest version of Semaphore on https://demo.ansible-semaphore.com.
|
|
|
|
## Docs
|
|
|
|
Admin and user docs: https://docs.ansible-semaphore.com
|
|
|
|
API description: https://ansible-semaphore.com/api-docs/
|
|
|
|
## Contributing
|
|
|
|
PR's & UX reviews are welcome!
|
|
|
|
Please follow the [contribution](https://github.com/ansible-semaphore/semaphore/blob/develop/CONTRIBUTING.md) guide. Any questions, please open an issue.
|
|
|
|
## Release Signing
|
|
|
|
All releases after 2.5.1 are signed with the gpg public key
|
|
`8CDE D132 5E96 F1D9 EABF 17D4 2C96 CF7D D27F AB82`
|
|
|
|
## Support
|
|
|
|
If you like Ansible Semaphore, you can support the project development on [Ko-fi](https://ko-fi.com/fiftin).
|
|
|
|
[<img src="https://user-images.githubusercontent.com/914224/203517453-4febf7f6-debb-4be9-b6a2-a3b19f5d9f9a.png">](https://ko-fi.com/fiftin)
|
|
|
|
|
|
## License
|
|
|
|
MIT License
|
|
|
|
Copyright (c) 2016 Castaway Consulting LLC
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
in the Software without restriction, including without limitation the rights
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in all
|
|
copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
SOFTWARE.
|