repository·master·Indexed 41 days ago
https://github.com/assetto-corsa-web/accwebA web interface for managing Assetto Corsa Competizione servers. It enables users to create, configure, start, stop, and monitor multiple server instances, view logs, and manage configurations via a browser. The tool is available as a binary for Linux and Windows, or as a Docker image.
To perform a backup of your accweb installation, you must save two components:
config directory.config.yml file.When migrating to a new version of accweb, you can place the config directory into the new installation folder. However, do not overwrite the new config.yml with your old one directly, as there may be breaking changes; instead, manually adjust the new config.yml based on your old settings.
To run accweb locally for development, ensure the dev attribute is set to true in your config.yml file.
The frontend is built with Vue.js and located in the public directory. Use the following command to start a watcher that rebuilds the JS package whenever files are edited:
make run-dev-frontendThe backend is written in Go and located in the internal directory. Use the following command to run the backend:
make run-dev-backendNote: You must restart the backend command to see changes made to the Go code.
# Start frontend watcher
make run-dev-frontend
# Start backend
make run-dev-backendTo install accweb on your server, follow these steps:
config.yml file to configure your settings../accwebaccweb.exehttp://example.com:8080).Important Notes:
--config or -c flag.config.yml.# Start with a specific config file
./accweb --config server1.ymlTo build a new release, use the build_release.sh script. You must provide the build version as the first argument. This will generate a directory in releases/accweb_<version> containing the build, which can then be zipped and deployed.
./build/build_release.sh 1.2.3accweb is available as a Docker image. For detailed instructions and image information, visit the official Docker Hub repository.
https://hub.docker.com/r/accweb/accwebThe API is organized into groups with increasing permission levels. All routes are prefixed with /api and require JWT authentication via the Authorization header or token query parameter.
/api/*)Requires a valid JWT. Common endpoints:
GET /servers: List all servers.GET /metadata: Get API metadata.GET /instance/:id: Get instance details.GET /instance/:id/logs: Get instance logs.GET /instance/:id/live: Get live state.GET /instance/:id/export: Export instance configuration./api/*)Requires ACCWebAuthLevel_Mod permission. Endpoints:
POST /servers/stop-all: Stop all running servers.POST /instance/:id/start: Start a specific instance.POST /instance/:id/stop: Stop a specific instance./api/*)Requires ACCWebAuthLevel_Adm permission. Endpoints:
POST /instance: Create a new instance.POST /instance/:id: Save instance configuration.DELETE /instance/:id: Delete an instance.POST /instance/:id/clone: Clone an instance.GET/POST /configure/global-entrylist: Manage global admins.GET/POST/DELETE /configure/global-ban: Manage global bans.Authentication is handled via JWT. Users are identified by a User struct containing their permissions.
User Schema:
user_name (string): The username.admin (bool): Full administrative access.mod (bool): Moderator access (includes Read-Only).read_only (bool): Read-only access.Authentication Flow:
POST to /api/login with a JSON body: {"password": "your_password"}.config.Auth.AdminPassword, config.Auth.ModeratorPassword, or config.Auth.ReadOnlyPassword and returns a JWT.Authorization header.// LoginPayload
{
"password": "string"
}// Successful Login Response
{
"code": 200,
"token": "JWT_STRING",
"expire": "2026-01-24T12:00:00Z",
"user_name": "username",
"admin": true,
"mod": true,
"read_only": true
}The accweb service relies on three named volumes for data persistence. Ensure these are mapped correctly in your deployment to prevent data loss:
accweb: Maps to /accweb inside the container (application data).acccerts: Maps to /sslcerts inside the container (SSL certificates).accserver: Maps to /accserver inside the container (server configuration/data).volumes:
- "accweb:/accweb"
- "acccerts:/sslcerts"
- "accserver:/accserver"You can manage access levels and security settings for the accweb container using the following environment variables:
ACCWEB_ADMIN_PASSWORD: Password for administrative access.ACCWEB_MOD_PASSWORD: Password for moderator access.ACCWEB_RO_PASSWORD: Password for read-only access.ACCWEB_ENABLE_TLS: Set to "true" to enable TLS.ACCWEB_CERT_FILE: Path to the certificate file inside the container (default: /sslcerts/certificate.crt).ACCWEB_PRIV_FILE: Path to the private key file inside the container (default: /sslcerts/private.key).ACCWEB_LOGLEVEL: Sets the logging verbosity (e.g., info).ACCWEB_CORS: Configures Cross-Origin Resource Sharing (e.g., * for all origins).getLocale function determines the user's preferred language based on the browser's navigator.languages property. It iterates through available languages and attempts to match them against a supported list of two-character lowercase ISO language codes. If no match is found, it defaults to `The accweb service can be deployed using Docker Compose. It exposes the web interface on port 8080 and uses several environment variables to control security, authentication, and logging.
8080 to container port 8080 by default.accnetwork.| Variable | Description |
|---|---|
ACCWEB_HOST | The host and port the server binds to (e.g., 0.0.0.0:8080). |
ACCWEB_ENABLE_TLS | Enables or disables TLS (use ` |
Use StartServer to initialize and run the HTTP server. It configures the Gin engine based on the config.Dev flag, sets up CORS using config.CORS.Origins, and mounts the API routes and static files. The server can run with or without TLS depending on config.Webserver.TLS.
import (
"github.com/assetto-corsa-web/accweb/internal/pkg/cfg"
"github.com/assetto-corsa-web/accweb/internal/pkg/server_manager"
)
// config is an instance of cfg.Config
// sM is an instance of server_manager.Service
StartServer(config, sM)