stationmaster
v0.1.1
Published
Branch status and integration/deployment tools
Downloads
7
Readme
stationmaster
Branch status and integration/deployment tools
What does it do?
StationMaster is suitable for a project that has a dev domain that multiple branches are deployed to, for example:
foo.dev.company.com
bar.dev.company.com
StationMaster simply has a page that indexes the dev domains you have. So, you hook StationMaster into your deployment scripts and hey presto! You can keep track of what domains were deployed and when!
Boundaries
All StationMaster does is:
- Has a CSV that lists your dev domains
- Displays a page that reads in the CSV and renders links
So, this means that it's your responsibility to do things like:
- Set up the nginx or apache files to serve StationMaster
- Restart your web server
- Manage your domains, etc
Requirements
- A dev domain that all your sites are deployed to
- Ability to set up DNS etc to serve StationMaster
Dependencies
None, all dependencies are bundled. For development, dependencies are installed through NPM (see CONTRIBUTING.md for details).
Instructions
All you need to do is:
- Host stationmaster somewhere
- Have some way of updating stationmaster.csv
Here is an example Nginx configuration to serve stationmaster:
server {
listen 80;
keepalive_timeout 55;
access_log /var/log/nginx/stationmaster_access.log;
error_log /var/log/nginx/stationmaster_error.log;
server_name dev.company.com;
root /opt/stationmaster/public;
index index.html;
location ~* \.(csv)$ {
expires -1;
}
gzip_types text/plain text/css application/x-javascript text/xml application/xml application/xml+rss text/javascript application/json;
}
Updating StationMaster through Ansible Galaxy
If you use Ansible, you can use StationMaster-ansible to manage StationMaster:
Once you've configured it...
When it's set up and deploying index.html, you will need to set up your web server to actually serve it. StationMaster takes no part in actually configuring web servers, all it provides is the basic HTML.