Flamenco/README.md

28 lines
1.1 KiB
Markdown
Raw Normal View History

2022-01-10 13:14:38 +00:00
# Flamenco PoC
This repository contains a proof of concept of a next-generation Flamenco implementation.
## Building
1. Install [Go 1.17 or newer](https://go.dev/).
2022-01-10 13:46:12 +00:00
2. Set the environment variable `GOPATH` to where you want Go to put its packages. Defaults to `$HOME/go` if not set. Run `go env GOPATH` if you're not sure.
3. Ensure `$GOPATH/bin` is included in your `$PATH` environment variable.
4. Run `make with-deps` to install build-time dependencies and build the application. Subsequent builds can just run `make` without arguments.
2022-01-10 13:14:38 +00:00
You should now have two executables: `flamenco-manager-poc` and `flamenco-worker-poc`.
## Swagger UI
Flamenco Manager has a SwaggerUI interface at http://localhost:8080/api/swagger-ui/
2022-01-25 16:28:12 +00:00
## Flamenco Manager DB development machine setup.
2022-01-25 16:28:12 +00:00
Install PostgreSQL, then run:
```
2022-01-25 16:28:12 +00:00
sudo -u postgres createuser -D -P flamenco # give it the password 'flamenco'
sudo -u postgres createdb flamenco -O flamenco -E utf8
sudo -u postgres createdb flamenco-test -O flamenco -E utf8
echo "alter schema public owner to flamenco;" | sudo -u postgres psql flamenco-test
```