RESTful API for Dokku exposed locally on port :3000.
- Go
- MongoDB
Build from root of the repository: go build -o dokkuapi main.go or for linux deployment GOOS=linux GOARCH=amd64 go build
Run without building go run main.go
Don't forget to set all necessary environmental variables. You can run it locally with ./start_with_env.sh. On server it's required to set them in /etc/systemd/system/dokkuapi.service file. EnvironmentFile links to dokkuapi_env file, which contains also variables required for dokku, not only for dokkuapi.
- DB_URI
- DB_USERNAME
- DB_PWD
- JWT_TOKEN_SECRET
- ...
| Path | Method | Description |
|---|---|---|
| /info | GET | temporary endpoint |
| /register | POST | to register with github |
| /login | POST | to login with github |
| /logout | POST | to deny access to api |
| /users/{userId} | DELETE | delete user according userId |
| /users/{userId} | PUT | update user setup |
| /apps/ | GET | retrieve info about user's applications |
| /apps/ | POST | create application |
| /apps/{appId} | DELETE | delete user's application according appId |
| /apps/{appId} | PUT | edit application |
| /apps/{appId}/logs | GET | provides app's logs |
| /apps/{appId}/logs-failed | GET | provides logs for app's last failed build |
| /apps/{appId}/deploy | POST | use .tar file to deploy application |
| /apps/{appId}/stop | PUT | stop running application |
| /apps/{appId}/start | PUT | start stopped application |
| /apps/{appId}/restart | PUT | restart deployed application |
| /apps/{appId}/rebuild | PUT | rebuild deployed application |
| /apps/{appId}/instances | GET | provide app's instances info |
| /apps/{appId}/instances | PUT | to scale app's instances |
| /apps/{appId}/services | POST | create and link backing service to application |
| /apps/{appId}/services | GET | retrieve backing service information |
| /apps/{appId}/services/{serviceId} | DELETE | unlink and delete service of application |
Requires project directory compressed into .tar file. POST request should contains body form-data with app_source_code key and file value.
Logging is provided by package logger. It exposes GeneralLogger and ErrorLogger to log api runtime into dokkuapi.log file. Webserver traffic is logged separate to dokkuapi_webserver.log file via gorilla/handler.