focalboard/README.md

48 lines
1.2 KiB
Markdown
Raw Normal View History

2020-10-08 18:26:05 +02:00
# mattermost-octo-tasks
2020-10-26 20:45:40 +01:00
## Building the server
2020-10-08 18:26:05 +02:00
```
make prebuild
2020-10-08 18:26:05 +02:00
make
```
Currently tested with:
* Go 1.15.2
2020-10-08 19:01:56 +02:00
* MacOS Catalina (10.15.6)
2020-10-26 20:45:40 +01:00
* Ubuntu 18.04
2020-11-07 19:50:34 +01:00
* Windows 10
2020-10-08 19:01:56 +02:00
2020-11-07 19:50:34 +01:00
The server defaults to using SQLite as the store, but can be configured to use Postgres:
2020-10-08 19:01:56 +02:00
* In config.json
* Set dbtype to "postgres"
* Set dbconfig to the connection string (which you can copy from dbconfig_postgres)
* Create a new "octo" database with psql
* Restart the server
2020-10-08 18:29:48 +02:00
2020-10-26 20:45:40 +01:00
## Running and testing the server
2020-10-08 18:29:48 +02:00
2020-11-07 19:50:34 +01:00
To start the server, run `./bin/octoserver`
2020-10-08 18:29:48 +02:00
Server settings are in config.json.
Open a browser to [http://localhost:8000](http://localhost:8000) to start.
2020-10-26 20:45:40 +01:00
2020-11-07 19:50:34 +01:00
## Building and running standalone desktop apps
2020-10-26 20:45:40 +01:00
2020-11-07 19:50:34 +01:00
You can build standalone apps that package the server to run locally against SQLite:
* Mac:
* `make mac-app`
* run `mac/dist/Tasks.app`
* *Requires: macOS Catalina (10.15), Xcode 12 and a development signing certificate.*
* Linux:
* `make linux-app`
* run `linux/dist/tasks-app`
* Windows
* `make win-app`
* run `win/dist/tasks-win.exe`
* *Requires: Windows 10*
2020-10-26 20:45:40 +01:00
2020-11-07 19:50:34 +01:00
Cross-compilation currently isn't fully supported, so please build on the appropriate platform.