Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alfg authored Dec 27, 2019
1 parent 4d6ca02 commit 77c2938
Showing 1 changed file with 6 additions and 21 deletions.
27 changes: 6 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,42 +58,27 @@ docker-compose up -d redis
docker-compose up -d db
```

When the database container runs for the first time, it will create a persistent volume as `/var/lib/postgresql/data`. It will also run the scripts in `scripts/` to create the database, schema, settings and presets.


* Set environment variables in `docker-compose.yml`.

*Environment variables will override defaults set in `config/default.yml`.*
When the database container runs for the first time, it will create a persistent volume as `/var/lib/postgresql/data`. It will also run the scripts in `scripts/` to create the database, schema, settings, presets, and an admin user.

* Build & start API server:
```
go build -v && openencoder.exe server
go build -v && ./openencoder server
```

* Build & start worker:
* Start the worker:
```
go build -v && openencoder.exe worker
./openencoder worker
```

* Start Web Dashboard for development:
```
cd static && npm run serve
```

## Example Usage
```bash
curl -X POST \
http://localhost:8080/api/jobs \
-H 'Content-Type: application/json' \
-d '{
"preset": "h264_baseline_360p_600",
"source": "s3:///src/ToS-1080p.mp4",
"dest": "s3:///dst/tears-of-steel/"
}'
```
* Open `http://localhost:8081/dashboard` in the browser and login with `admin/password`.

See [API.md](/API.md) for full jobs API documentation.

See [Quick-Setup-Guide](https://github.com/alfg/openencoder/wiki/Quick-Setup-Guide-%5Bfor-development%5D) for full development setup guide.

## API
See: [API.md](/API.md)
Expand Down

0 comments on commit 77c2938

Please sign in to comment.