multiscan / accweb

Assetto Corsa Competizione Server Management Tool via Web Interface.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Assetto Corsa Competizione Server Web Interface

CircleCI Go Report Card

The successor of acweb! accweb lets you manage your Assetto Corsa Competizione servers via a nice and simple web interface. You can start, stop and configure server instances and monitor their status.

Table of contents

  1. Features
  2. Installation
  3. Backup
  4. Contribute and support
  5. Links
  6. License
  7. Screenshots

Features

  • create and manage as many server instances as you like
  • configure your instances in browser
  • start/stop instances and monitor their status
  • view server logs
  • copy server configurations
  • import/export server configuration files
  • delete server configurations
  • three different permissions: admin, mod and read only (using three different passwords)
  • status page for non logged in users
  • easy setup
    • no database required
    • simple configuration using environment variables

accweb can be installed manually or by using Docker. Both installation methods use environment variables for configuration. Here is a list with all configuration variables and possible values. The instructions below don't use all of them.

ACCWEB_LOGLEVEL=debug|info
ACCWEB_ALLOWED_ORIGINS=*|<your domain or IP>
ACCWEB_CORS_LOGLEVEL=debug|<empty>
ACCWEB_HTTP_WRITE_TIMEOUT=<seconds>
ACCWEB_HTTP_READ_TIMEOUT<seconds>
ACCWEB_HOST=<ip>:<port>
ACCWEB_TLS_ENABLE=true|false
ACCWEB_TLS_CERT=<path to certificate>
ACCWEB_TLS_PKEY=<path to private key>
ACCWEB_CONFIG_PATH=<path server configurations are stored>
ACCWEB_SERVER_DIR=<path to ACC server directory>
ACCWEB_TOKEN_PUBLIC_KEY=<path to public key for token generation>
ACCWEB_TOKEN_PRIVATE_KEY=<path to private key for token generation>
ACCWEB_ADMIN_PASSWORD=<password>
ACCWEB_MOD_PASSWORD=<password>
ACCWEB_RO_PASSWORD=<password>

To set one of these, use set NAME=value on Windows and export NAME=value on Linux before you start the accweb executable. The start.sh and start.cmd as well as the docker-compose.yml use recommended default values, but you meight have to change a few of them. ACCWEB_ADMIN_PASSWORD, ACCWEB_MOD_PASSWORD and ACCWEB_RO_PASSWORD are used to configure the administrator, moderator and read only passwords. They must be set or accweb won't start. Make sure you use a unique strong pasword for each of them.

  1. download the latest release from the release section on GitHub
  2. extract the zip file on your server
  3. edit the start.sh (Linux) or start.cmd (Windows) to your needs
  4. open a terminal
  5. change directory to the accweb installation location
  6. generate a new RSA key pair for user tokens (this is important for security!) and place them as token.private and token.public inside a new directory called secrets
  7. run the start script (./start.sh on Linux and start.cmd on Windows)
  8. leave the terminal open (or start in background using screens on Linux for example)
  9. visit the server IP/domain and port you've configured, for example: http://example.com:8080

I recommend to setup an SSL certificate, but that's out of scope for this instructions. You can enable a certificate by using the environment variables above.

To generate the RSA key pair, you can use the gen_rsa_keys.sh on Linux or install one of the tools available for Windows. You can also use an online service which generates RSA key pairs (search for "generate rsa key pair online").

Note that you have to install wine if you're on Linux.

Docker installation

WORK IN PROGRESS, DO NOT USE YET

To be able to run accweb through Docker, you have to install Docker and Compose on your server. Please refer to the Docker/Compose documentation on how to do that.

  1. edit docker-compose.yml to your needs
  2. open a terminal
  3. change directory to the docker-compose.yml location
  4. start accweb with the command: docker-compose up -d

Backup

To backup your files, copy and save the config directory as well as the start.sh or start.cmd depending on your OS. The config directory can later be placed inside the new accweb version directory and you can adjust the new start.sh/start.cmd based on your old configuration (don't overwrite it, there meight be breaking changes).

If you like to contribute, have questions or suggestions you can open tickets and pull requests on GitHub.

All Go code must have been run through go fmt. The frontend and backend changes must be (manually) tested on your system. If you have issues running it locally open a ticket. You can use the dev.sh and gen_rsa_keys.sh scripts to start accweb on your computer (on Linux).

License

MIT

Login Overview Configuration Import Logs Status page

About

Assetto Corsa Competizione Server Management Tool via Web Interface.

License:MIT License


Languages

Language:Vue 46.8%Language:Go 38.0%Language:JavaScript 5.4%Language:CSS 3.7%Language:Batchfile 2.3%Language:Shell 1.8%Language:Dockerfile 1.1%Language:HTML 0.9%