Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/CAIDA/dzdb-web
DNS Zone DB Frontend Web Application
https://github.com/CAIDA/dzdb-web
Last synced: 5 days ago
JSON representation
DNS Zone DB Frontend Web Application
- Host: GitHub
- URL: https://github.com/CAIDA/dzdb-web
- Owner: CAIDA
- License: bsd-2-clause
- Created: 2020-04-30T05:11:02.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-05-22T17:37:48.000Z (6 months ago)
- Last Synced: 2024-08-01T22:01:07.389Z (3 months ago)
- Language: JavaScript
- Homepage: https://dzdb.caida.org
- Size: 580 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [DNS Coffee Frontend](https://dns.coffee)
## Building
Requires go compiler >= go1.13
```sh
$ make
```
## Running
Database connection information is set via `$DATABASE_URL` environment variable
The listen address and port can be set with a flag.
To run all thats needed is the compiled `dnscoffee` binary and the `static/` and `templates/` directories. The `static/` and `templates/` directories should be in the cwd when calling `dnscoffee`.
### Flags
```sh
$ ./dnscoffee -h
Usage of ./dnscoffee:
-listen string
ip:port to listen on (default "127.0.0.1:8080")
```
### Example
```sh
$ export DATABASE_URL="postgresql://user:pass@host:port/db"
$ ./dnscoffee
2020/04/29 21:45:22 Server starting on 127.0.0.1:8080
```
## Docker
The docker build used a 2-stage build. The first stage compiles the go program to a static binary, and the second stage copies the resulting binary and static files to a fresh image to run the web server.
### Build
```sh
$ make docker
```
### Run
docker-compose example:
```yaml
version: '3'
services:
web:
container_name: dnszone_web
image: lanrat/dnscoffee
restart: unless-stopped
environment:
- TZ=America/Los_Angeles
- DATABASE_URL="postgresql://user:pass@host:port/db"
- HTTP_LISTEN_ADDR=0.0.0.0:8082
healthcheck:
test: ["CMD-SHELL", "wget --quiet --tries=1 --spider http://localhost:8082/ || exit 1"]
interval: 30s
timeout: 10s
retries: 3
```
### Wiki
The API endpoints and their corresponding frontend links are listed [here](https://github.com/CAIDA/dzdb-web/wiki/DNS-Coffee-API-and-Frontend-Links).