https://github.com/onlinedi-vision/od-official-server
Official Server for onlinedi.vision
https://github.com/onlinedi-vision/od-official-server
api api-rest docker docker-compose jenkins rust
Last synced: 4 months ago
JSON representation
Official Server for onlinedi.vision
- Host: GitHub
- URL: https://github.com/onlinedi-vision/od-official-server
- Owner: onlinedi-vision
- License: gpl-3.0
- Created: 2025-01-05T03:52:43.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-03-06T00:57:10.000Z (4 months ago)
- Last Synced: 2026-03-06T01:02:14.357Z (4 months ago)
- Topics: api, api-rest, docker, docker-compose, jenkins, rust
- Language: Rust
- Homepage:
- Size: 934 KB
- Stars: 4
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Division Online Official Server
## Description
This is the "RESTful" API server of the Online Division project. In the near future this will also be the API server used by "self-hosters".
## Usage
Obviously, to be able to use the source code of the project you will have to first clone it:
```sh
$ git clone 'https://github.com/onlinedi-vision/od-official-server.git'
```
For the API server to properly run you also need a [scyllaDB](https://www.scylladb.com/) instance to which the server should connect to and use it as (well obviously) its data base.
You can do this manually, but more easily you can run the following command:
```sh
./launch-test-env.sh -sS
```
This command will run a docker container containing a scylla instance, and will compile the source code of od-official-server and run it connecting the two.
For more in depth analysis of what it does please either check out the code of `launch-test-env` or see the help message of the command:
```sh
./launch-test-env.sh -h
```
## Environment Variables
The "Test Env" sets up some random credentials (such as keys for encryption, and so on...). To have better control of what the keys are you can edit `launch-test-env.sh`, specifically these lines:
```sh
export SALT_ENCRYPTION_IV="ffA_1D6s^jf!6\$xx"
export SALT_ENCRYPTION_KEY='#a1aA3!h4a@ah3a4'
export SCYLLA_CASSANDRA_PASSWORD='cassandra'
export API_PORT=1313
export NO_OF_WORKERS=32
export EXECUTABLE_NAME="api"
```
These being the lines that set up the necessary environment variables for `od-official-server` to run successfuly.
## Contributing
Please checkout [CONTRIBUTING.md](./CONTRIBUTING.md) and [TESTING.md](./TESTING.md).