Package Exports
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@omer-x/buttler) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Buttler
Table of Contents
Overview
Buttler automates CI/CD workflows using Docker and GitHub webhooks
Features
- Dark Mode (see screenshots)
- Mega.io integration to save database backups (see screenshots)
- Hosting applications from a GitHub repository (see screenshots)
- must have a
Dockerfilein its root directory - can be a private repo, but ssh key of the hosting machine must be added to Deploy keys
- Creates a new build image automatically via GitHub webhooks and deploys it
- must have a
- Database services (see screenshots)
- Engines:
- PostgreSQL
- MySQL (not implemented yet)
- MongoDB (not implemented yet)
- Redis
- can be linked to other services (see screenshots)
- Engines:
- Services dashboard (see screenshots)
- Edit service page (see screenshots)
- Manage service ports
- Manage environment variables
- Copy-paste env variables easily
- Service details page (see screenshots)
- Container logs (see screenshots)
- List of build images (see screenshots)
- Button fir triggering a manual build for custom services (see screenshots)
- Button for triggering a manual backup for database services (see screenshots)
- Linking services (see screenshots)
- Creates private network between service containers
- Custom service inherits necessary env variables automatically for the database (see screenshots)
Planned features
You can find the planned features here
Known bugs
You can see the known bugs here
Requirements
To use Buttler, you'll need the following dependencies installed in your machine:
Installation
Install Buttler globally using npm:
npm i -g @omer-x/buttlerUsage
To launch the application
buttler startThen open your browser and navigate to:
http://localhost:2083To terminate the application
buttler stopTo relaunch the application
buttler restartScreenshots
Dark Mode

Settings

Custom service

Database service

List of services

Edit service page


Service details

Manual Build

List of build images

Manual backup

Container logs

Linking services


Auto env inheritance

Contributing
Contributions are welcome! Please open an issue or submit a pull request for any feature requests or bug fixes.
License
This project is licensed under the MIT License. See the LICENSE file for details.