https://github.com/luzlab/harbormaster-apache
https://github.com/luzlab/harbormaster-apache
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/luzlab/harbormaster-apache
- Owner: luzlab
- License: apache-2.0
- Created: 2017-03-23T05:09:08.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-03-24T20:47:12.000Z (over 8 years ago)
- Last Synced: 2025-04-10T13:06:35.344Z (over 1 year ago)
- Language: JavaScript
- Size: 84 KB
- Stars: 0
- Watchers: 1
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# harbormaster
[](https://travis-ci.org/trueandco/harbormaster)
General notes on things to do and how things work.
Features:
- [x] **Users**, who are able to login, edit their own profiles, and view the status of Lanes
- [x] **Harbormasters**, who can create Users, Ship to all Lanes, and promote Users to Captains or Harbormasters
- [x] **Captains**, who can sent Shipments to Lanes they Ply
- [x] **Lanes**, which represent deployment paths, comprised of individual Stops
- [x] **Stops**, which represent discrete individual deployment commands
- [x] **Shipments**, which represent individual executions of a Stop on a Lane
- [x] **Logs**, which are the output of Shipments
- [x] **Destinations**, which represent individual environments where Stops are executed
- [ ] **Manifests**, which are the order in which Stops are made at Destinations
- [ ] **Salvage Plans**, which are specialized Lanes to be executed when a Shipment fails
- [x] **Shipping**, the act of initiating discreet Shipments to a Lane
- [x] **Plying**, the responsibility of Shipping to a Lane
- [x] **Defining a Lane**, which allows input of individual commands as Stops, ordering them, and saving them for later execution
- [x] **Promoting & Demoting Users**, allowing Harbormasters to change roles
- [ ] **Dynamic stdin**, letting users input commands which require user input when run
- [x] **Hooks**, allowing remote calls to trigger shipments
- [ ] **Abort shipment**, canceling a shipment in the middle of it, optionally triggering a Salvage Plan
Environment variables you'll want if you run this docker container:
```
MAIL_URL=[username]:[password]@[smtp.someserver.com]:[port]
MONGO_URL=mongodb://[user]:[password]@[mongodb url]:[mongodb port]/[db name, usually "harbormaster"]
ROOT_URL=http[s]://[wherever the app is running][:port]
PORT=[usually 80]
```