26 lines
940 B
Markdown
26 lines
940 B
Markdown
# Supercardinality Online Services
|
|
|
|
The reference implementation for online services for Supercardinality.
|
|
|
|
## Setup
|
|
|
|
Create the `config.php` file based on `config.php.example`.
|
|
|
|
Host the repo root using a PHP capable web server.
|
|
|
|
It's a good idea to block access to your state file.
|
|
A common way to protect it from being publicly readable is to configure it to be outside of the web server.
|
|
If you store it in the default location you may want to block access to it using URL rewrite rules.
|
|
|
|
---
|
|
|
|
For a quick (insecure) private online endpoint you can just run:
|
|
```sh
|
|
# The online URL to set in game should be a publicly accessible IP address of your machine.
|
|
# Change 1337 to your preferred port. Ports below 1024 may need root privileges.
|
|
# Change 0.0.0.0 to [::] to use IPv6 instead of IPv4.
|
|
php -S 0.0.0.0:1337
|
|
```
|
|
|
|
The same method is recommended for local development. Change the IP to `127.0.0.1` or `[::1]` to only allow localhost.
|