Skip to content
This repository was archived by the owner on Jun 3, 2023. It is now read-only.

Commit 1c243f0

Browse files
committed
Add app.json manifest, update documentation
1 parent 9feb0f9 commit 1c243f0

File tree

2 files changed

+26
-4
lines changed

2 files changed

+26
-4
lines changed

‎README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
11
# Automatically Managed DNS
22

3-
A system to automate the management of DNS A records for a large number of servers.
3+
A system to automate the management of DNS A records for an arbitrary number of servers.
44

55
## Run
66

77
### Locally
88

99
Clone, set up a virtual environment with `make venv` and enter it with `source venv/bin/activate`.
1010

11-
The application expects AWS API secrets as the environment variables `AWS_ACCESS_ID`, `AWS_ACCESS_SECRET`.
11+
The application expects AWS API secrets as the environment variables `AWS_ACCESS_ID`, `AWS_ACCESS_SECRET` and a pseudo-random `SECRET_KEY`.
1212

13-
Then run with `./run.py` to serve the web interface on `localhost:5000`. In `dns.create_instances()` some toy data is created.
13+
Run with `./run.py` or `flask run` to serve the web interface in development mode on `localhost:5000` with Flask. To serve with `gunicorn` on `localhost:8000`, run the command in `Procfile`. Simulate a deployment with `heroku local`.
1414

15-
Currently deployed to [lit-tundra-97584.herokuapp.com](https://lit-tundra-97584.herokuapp.com/).
15+
Some toy data is created in `dns.create_instances`.
1616

17+
### Deploy
18+
19+
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/fionn/dns-automator)

‎app.json

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"name": "DNS Automator",
3+
"description": "Stub DNS management for Server Admin",
4+
"keywords": ["DNS", "route53", "AWS", "Flask"],
5+
"repository": "https://github.com/fionn/dns-automator",
6+
"success_url": "/",
7+
"env": {
8+
"SECRET_KEY": {
9+
"description": "Secret key for signing cookies",
10+
"generator": "secret"
11+
},
12+
"AWS_ACCESS_ID": {
13+
"description": "AWS key ID"
14+
},
15+
"AWS_ACCESS_SECRET": {
16+
"description": "AWS secret token"
17+
}
18+
}
19+
}

0 commit comments

Comments
 (0)