mirror of https://github.com/VinylDNS/vinyldns synced 2025-08-22 02:02:14 +00:00

History

- Move quickstart from `utils` to `quickstart`
- Update quickstart script to add more container manipulation
- Move API functional tests back under `modules/api`
- Move build-related scripts to `build/` directory
- Add quickstart containers that can run the local version of the code

2021-10-27 13:43:21 -04:00

api

Updates

2021-10-27 13:43:21 -04:00

bind9

Updates

2021-10-27 13:43:21 -04:00

portal

Updates

2021-10-27 13:43:21 -04:00

.env

Updates

2021-10-27 13:43:21 -04:00

docker-compose.yml

Updates

2021-10-27 13:43:21 -04:00

quickstart-vinyldns.sh

Updates

2021-10-27 13:43:21 -04:00

README.md

Updates

2021-10-27 13:43:21 -04:00

README.md

VinylDNS QuickStart

To get started with VinylDNS, you can experiment with the QuickStart.

QuickStart utilizes Docker Compose to start up the VinylDNS API and Portal along with required dependencies such as:

MySQL
OpenLDAP
SQS
SNS
BIND 9

Running

To run the QuickStart, you will need the following prerequisites:

Docker
Docker Compose

From a shell in the quickstart/ directory, simply run:

./quickstart-vinyldns.sh

The quickstart-vinyldns.sh script takes a number of optional arguments:

Flag	Description
-a, --api-only	do not start up the VinylDNS Portal
-b, --build	force a rebuild of the Docker images with the local code
-r, --reset	reset any the running containers
-s, --service	specify the service to run
-t, --timeout	the time to wait (in seconds) for the portal and API to start (default: 60)
-u, --update	remove the local quickstart images to force a re-pull from docker hub
-v, --version-tag	specify Docker image tag version (default: latest)