tuawosserver

README

Tuawosserver

Description

This is TuawosServer, a task management tool backend written in Go.

How to build from source

Requirements

• Go >= 1.12
• MongoDB

Building

Clone the sources from the repository and compile it with

make deps
make

and optionally

make test

to run tests.

How to run it

Self-built or downloaded release

To start the TuawosServer using the self-built or downloaded binary enter for use with a TOML config

./tuawosserver -c /path/to/config/config.toml

Using Docker

Probably an easiest way to try out Tuawosserver is using Docker. To pull the latest version from DockerHub and start it type

docker run -d --name tuawosserver -v /path/to/config/file.toml:/app/config/config.toml:ro torlenor/tuawosserver:latest

Configuration

API

The API can be configured to listen to a specific IP address and port. The section in the config has the form

[api]
  ip = "127.0.0.1" # IP to listen on for the REST API
  port = "8001" # Port to listen on for the REST API

MongoDB

To configure a MongoDB storage, add a section of the form

[mongo]
  URL = "mongodb://user1:test@localhost/tuawos" # URL to connect to
  Database = "tuawos" # Database to use

to the configuration.