Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dokku/dokku-maintenance
dokku plugin that gives the ability to manage application maintenance mode
https://github.com/dokku/dokku-maintenance
Last synced: 3 months ago
JSON representation
dokku plugin that gives the ability to manage application maintenance mode
- Host: GitHub
- URL: https://github.com/dokku/dokku-maintenance
- Owner: dokku
- License: mit
- Created: 2015-03-06T17:47:15.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-10-05T18:54:15.000Z (4 months ago)
- Last Synced: 2024-10-30T00:56:03.792Z (3 months ago)
- Language: Shell
- Homepage:
- Size: 46.9 KB
- Stars: 113
- Watchers: 7
- Forks: 14
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - dokku/dokku-maintenance - dokku plugin that gives the ability to manage application maintenance mode (others)
README
# dokku-maintenance
dokku-maintenance is a plugin for [dokku](https://github.com/progrium/dokku) that gives the ability to enable or disable maintenance mode for an application.
## requirements
- dokku 0.4.x+
- docker 1.8.x
## installation
```shell
# on 0.4.x+
sudo dokku plugin:install https://github.com/dokku/dokku-maintenance.git maintenance
```
## commands
```
$ dokku help
maintenance Display the list of commands
maintenance:custom-page Imports a tarball from stdin; should contain at least maintenance.html
maintenance:disable Disable app maintenance mode
maintenance:enable Enable app maintenance mode
maintenance:report [] [] Displays a maintenance report for one or more apps
```
## usage
Check maintenance status of my-app
```
# dokku maintenance:report my-app # Server side
$ ssh dokku@server maintenance:report my-app # Client side
-----> Maintenance status of my-app:
off
```
Enable maintenance mode for my-app
```
# dokku maintenance:enable my-app # Server side
$ ssh dokku@server maintenance:enable my-app # Client side
-----> Enabling maintenance mode for ruby-test...
done
```
Disable maintenance mode for my-app
```
# dokku maintenance:disable my-app # Server side
$ ssh dokku@server maintenance:disable my-app # Client side
-----> Disabling maintenance mode for ruby-test...
done
```
Use a custom page for maintenance
```
# dokku maintenance:custom-page my-app < my-custom-page.tar # Server side
$ ssh dokku@server maintenance:custom-page my-app < my-custom-page.tar # Client side
-----> Importing custom maintenance page...
maintenance.html
image.jpg
done
```
You have to provide at least a maintenance.html page but you can provide images, css, custom font, etc. if you want. Just write absolute paths in your html and not relative ones (so to serve image.jpg which is at the same level than your maintenance.html page you’ll write “/image.jpg” instead of “./image.jpg” or “image.jpg”).