Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
engine-api
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
AURA
engine-api
Commits
8d2470e7
Commit
8d2470e7
authored
3 years ago
by
David Trattnig
Browse files
Options
Downloads
Patches
Plain Diff
Add details on Gunicorn and config.
parent
6f166195
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+21
-3
21 additions, 3 deletions
README.md
with
21 additions
and
3 deletions
README.md
+
21
−
3
View file @
8d2470e7
...
...
@@ -30,6 +30,7 @@
2.
[
Extending the API
](
#extending-the-api
)
3.
[
Creating a local image
](
#creating-a-local-image
)
4.
[
Publish new image
](
#publish-new-image
)
6.
[
Logging
](
#logging
)
2.
[
About
](
#about
)
<!-- /TOC -->
...
...
@@ -120,6 +121,10 @@ If you are not planning to go with Docker or just want to setup a local developm
-
[
`git`
](
https://git-scm.com/
)
-
[
PostgreSQL 13+
](
https://www.postgresql.org/
)
For Production use you also need following:
-
[
Gunicorn
](
https://gunicorn.org/
)
, or any other compatible WSGI server
### Installation
Create a virtual environment for your Python dependencies:
...
...
@@ -155,10 +160,19 @@ You might want to change the password for the database user created by the relev
### Configuration
Copy the sample configuration file in
`./config/sample/sample-production.engine-api`
to
`config`
and edit the file.
Create a config file from the sample configuration file:
```
bash
# Development
engine-api
$
cp
config/sample/sample-development.engine-api.ini config/engine-api.ini
# Production
engine-api
$
cp
config/sample/sample-production.engine-api.ini config/engine-api.ini
```
First update the main configuration, such as your database connection and the default port. Also set the correct IP
and port in
`gunicorn.conf.py`
file.
Now edit the configuration file. If you trust all the defaults you'll only need to change the database password.
For some deployment like production you may want to change the default port too.
In this case also set the correct IP and port in
`gunicorn.conf.py`
file.
> You might also need to 'open' the chosen port in your `iptables` (Default is 8008)
...
...
@@ -404,6 +418,10 @@ If you are developer and want to publish a new image to DockerHub, run
./run.sh docker:push
```
## Logging
The Engine API logs can be found under
`./logs`
.
# About
Aura Engine API is the API interface for the play-out engine of the
[
Aura Radio Software Suite
](
https://gitlab.servus.at/aura/meta
)
.
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment