https://github.com/barelyhuman/dokcli
Setup dokku apps with generated scripts
https://github.com/barelyhuman/dokcli
automation dokku go scripts
Last synced: 5 months ago
JSON representation
Setup dokku apps with generated scripts
- Host: GitHub
- URL: https://github.com/barelyhuman/dokcli
- Owner: barelyhuman
- License: mit
- Archived: true
- Created: 2021-02-18T11:50:48.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-06-14T08:26:31.000Z (about 4 years ago)
- Last Synced: 2024-10-02T08:44:56.090Z (9 months ago)
- Topics: automation, dokku, go, scripts
- Language: Go
- Homepage:
- Size: 915 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# dokcli
[](https://github.com/barelyhuman/dokcli/actions/workflows/create-binaries.yml)
[](https://goreportcard.com/report/github.com/barelyhuman/dokcli)
## Motivation
I use [dokku](https://github.com/dokku/dokku) a for most deployments and while their cli is pretty extensive a certain set of operations could be better in terms of creating an App.
There's always predefined steps for various apps and hence I'd like to have a cli that can act as a wrapper around dokku to make it easier for me to create apps.
## Key Features (For now)
- [x] Create a New App
- [x] Enter app name
- [x] Select database plugin
- [x] link database to app
- [x] Add domain to the app
- [x] Add Let's encrypt
- [ ] Delete App
- [ ] Unlink all the above
- [ ] clean up un-used images
## Roadmap
- Cli for creation and deletion of app
- Lightweight Web-UI for the same
## Installation
Download the binary from releases from the browser or using curl
```bash
# For linux / unix, make sure wget is installed
curl -s https://api.github.com/repos/barelyhuman/dokcli/releases/latest | grep browser_download_url | grep linux-amd64 | cut -d '"' -f 4 | wget -qi -
tar -xvzf dokcli-linux-amd64.tar.gz
```
copy it to `/usr/local/bin` and make sure it's added to your PATH
```bash
cp dokcli /usr/local/bin
export PATH=$PATH:/usr/local/bin
```
## Usage
**Note: Make sure you have dokku installed**
For now the cli just creates a script for you to setup a dokku as needed.
(**Step 0 is optional**), the cli will ask you the needed information.
0. Create a yml file named `dokku-gen.yml`. You can use the provided template [dokku-gen.template.yml](dokku-gen.template.yml)
1. Run `dokcli` on the system to create the app on.
2. A script with the app name will be generated for you (screenshot below) with the name of `dokku-setup-.sh`
3. `chmod +x ./dokku-setup-.sh`
4. `./dokku-setup-.sh` to run the generated script.
**Example of a generated script**
## Dev
Make sure you have a minimum of `go 1.5`
_Run_
```bash
go run .
```
_Build_
```bash
go build .
```
## Contribution
Check the issues for things you can pick up and send through a PR for