6.6 KiB
6.6 KiB
ARTEMiS Configuration
Server
listen_address
: IP Address or hostname that the server will listen for connections on. Set to 127.0.0.1 for local only, or 0.0.0.0 for all interfaces. Default127.0.0.1
hostname
: Hostname that gets sent to clients to tell them where to connect. Games must be able to connect to your server via the hostname or IP you spcify here. Note that most games will rejectlocalhost
or127.0.0.1
. Defaultlocalhost
port
: Port that the server will listen for connections on. Default80
ssl_key
: Location of the ssl server key for the secure title server. Ignored if you don't use SSL. Defaultcert/title.key
ssl_cert
: Location of the ssl server certificate for the secure title server. Must not be a self-signed SSL. Ignored if you don't use SSL. Defaultcert/title.pem
allow_user_registration
: Allows users to register in-game via the AimeDBregister
function. Disable to be able to control who can use cards on your server. DefaultTrue
allow_unregistered_serials
: Allows games that do not have registered keychips to connect and authenticate. Disable to restrict who can connect to your server. Recomended to disable for production setups. DefaultTrue
name
: Name for the server, used by some games in their default MOTDs. DefaultARTEMiS
is_develop
: Flags that the server is a development instance, and enables some useful development features. Disable for production setups. DefaultTrue
.is_using_proxy
: Flags that you'll be using some other software, such as nginx, to proxy requests, and to sendproxy_port
orproxy_port_ssl
to games instead ofport
. DefaultFalse
proxy_port
: Which port your front-facing proxy will be listening on. Ignored ifis_using_proxy
isFalse
or if set to0
. Default0
proxy_port
: Which port your front-facing proxy will be listening for ssl connections on. Ignored ifis_using_proxy
isFalse
or if set to0
. Default0
log_dir
: Directory to store logs. Server MUST have read and write permissions to this directory or you will have issues. Defaultlogs
check_arcade_ip
: Checks IPs against thearcade
table in the database, if one is defined. DefaultFalse
strict_ip_checking
: Rejects clients if there is no IP in thearcade
table for the respective arcade. DefaultFalse
Title
loglevel
: Logging level for the title server. Defaultinfo
reboot_start_time
: 24 hour JST time that clients will see as the start of maintenance period, ex04:00
. A few games or early version will report errors if it is empty, ex maimai DX 1.00reboot_end_time
: 24 hour JST time that clients will see as the end of maintenance period, ex07:00
. this must be set to 7:00 am for some game, please do not change it.
Database
host
: Host of the database. Defaultlocalhost
username
: Username of the account the server should connect to the database with. Defaultaime
password
: Password of the account the server should connect to the database with. Defaultaime
name
: Name of the database the server should expect. Defaultaime
port
: Port the database server is listening on. Default3306
protocol
: Protocol used in the connection string, e.imysql
would result inmysql://...
. Defaultmysql
sha2_password
: Whether or not the password in the connection string should be hashed via SHA2. DefaultFalse
loglevel
: Logging level for the database. Defaultinfo
memcached_host
: Host of the memcached server. Defaultlocalhost
Frontend
enable
: Whether or not the frontend servlet should run. Frontend can still be run viapython -m uvicorn core.frontend:app
even if this is set toFalse
. DefaultFalse
port
: Port the frontend should listen on. Default8080
loglevel
: Logging level for the frontend server. Defaultinfo
secret
: Base64-encoded JWT secret for session cookies, generated by you. Default""
Allnet
standalone
: Whether allnet should launch it's own servlet on it's own port, or be part of the main servlet on the default port. Disable if you either have something proxyingnaominet.jp
requests to port 80, or have port 80 set inserver
->port
port
: Port the allnet server should listen for connections on if it's running standalone. Games are hardcoded to ask for port80
so only change if you have a proxy redirecting properly. Ignored ifstandalone
isFalse
. Default80
loglevel
: Logging level for the allnet server. Defaultinfo
allow_online_updates
: Allow allnet to distribute online updates via DownloadOrders. This system is currently non-functional, so leave it disabled. DefaultFalse
update_cfg_folder
: Folder where delivery INI files will be checked for. Ignored ifallow_online_updates
isFalse
. Default""
Billing
standalone
: Whether the billing server should launch it's own servlet on it's own port, or be part of the main servlet on the default port. Setting this toTrue
requires that you havessl_key
andssl_cert
set. DefaultFalse
loglevel
: Logging level for the billing server. Defaultinfo
port
: Port the billing server should listen for connections on. Games are hardcoded to ask for port8443
so only change if you have a proxy redirecting properly. Ignored ifstandalone
isFalse
. Default8443
ssl_key
: Location of the ssl server key for the billing server. Ignored ifstandalone
isFalse
. Defaultcert/server.key
ssl_cert
: Location of the ssl server certificate for the billing server. Ignored ifstandalone
isFalse
. Must match the CA distributed to users or the billing server will not connect. Defaultcert/server.pem
signing_key
: Location of the RSA Private key used to sign billing requests. Must match the public key distributed to users or the billing server will not connect. Defaultcert/billing.key
Aimedb
enable
: Whether or not aimedb should run. DefaultTrue
listen_address
: IP Address or hostname that the aimedb server will listen for connections on. Leave this blank to use the listen address underserver
. Default""
loglevel
: Logging level for the aimedb server. Defaultinfo
port
: Port the aimedb server should listen for connections on. Games are hardcoded to ask for port22345
so only change if you have a proxy redirecting properly. Default22345
key
: Key to encrypt/decrypt aimedb requests and responses. MUST be set or the server will not start. If set incorrectly, your server will not properly handle aimedb requests. Default""
id_secret
: Base64-encoded JWT secret for Sega Auth IDs. Leaving this blank disables this feature. Default""
id_lifetime_seconds
: Number of secons a JWT generated should be valid for. Default86400
(1 day)