Server for code smell research data
228
Olfaction is a server with storage backend for code smell research data. It exposes GraphQL and REST APIs over stored code smells and the version control information of analyzed repositories.
The following environment variables are used to configure the server:
| Name | Default | Description |
|---|---|---|
HOST | localhost | Host for the HTTP API server to listen on |
PORT | 4040 | Port for the HTTP API server to listen on |
REPO_ROOT | ./repos | Root directory where to find and store uploaded git repositories |
PGHOST | localhost | Postgres database host |
PGPORT | 5432 | Postgres database host |
PGUSER | Postgres database user name | |
PGPASSWORD | Postgres database password | |
PGDATABASE | Postgres database name | |
BASIC_AUTH_USERS | If set, restricts access through HTTP basic auth. JSON object of usernames as keys and passwords as values. |
Additionally, the optional OpenTracing support using Jaeger is configured through environment variables documented in the Jaeger client documentation.
To disable OpenTracing completely, JAEGER_DISABLED can be set to true.
Make sure the above environment variables are set.
Create a database with PostgreSQL:
createdb olfaction
Then initialize the schema:
psql < ./schema/schema.sql
To optimize performance, it is recommended to tweak the settings postgresql.conf depending on the available system resources.
Content type
Image
Digest
Size
560.1 MB
Last updated
over 6 years ago
docker pull felixfbecker/olfaction