blasthavers/blastmud-site
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Increase header levels by 1 to fix menu.

Browse Source
This commit is contained in:
Condorra 2024-11-16 22:48:44 +11:00
parent f600339fe5
commit 148ec42c73
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
worldwideportal-static/content/docs/setup-guide.md
View File

@ -5,7 +5,7 @@ for you.
No matter which option you take, you'll need either a Linux system of some form. This could be the same system you host your MUD on, or a different one if necessary. You could self-host, or use a cheap cloud instance (try Linode, Vultr, DigitalOcean etc..., or find a provider on Lowendbox). Mac or Windows users can either manually run a Linux VM (and be sure to forward the ports mentioned to it), or use Docker Desktop or similar container technology that automatically runs containers in a VM. No matter which option you take, you'll need either a Linux system of some form. This could be the same system you host your MUD on, or a different one if necessary. You could self-host, or use a cheap cloud instance (try Linode, Vultr, DigitalOcean etc..., or find a provider on Lowendbox). Mac or Windows users can either manually run a Linux VM (and be sure to forward the ports mentioned to it), or use Docker Desktop or similar container technology that automatically runs containers in a VM.
# First step: Pick an approach ## First step: Pick an approach
Worldwideportal provides a few options for how you set it up, ranging from really quick and easy Worldwideportal provides a few options for how you set it up, ranging from really quick and easy
options where everything is automated, to options that give you more control. Pick the option that options where everything is automated, to options that give you more control. Pick the option that
@ -18,9 +18,9 @@ Don't worry if you don't understand everything here - just default to the simple
* Or: Run Worldwideportal from a container without enabling TLS (HTTPS), but set it up so it is only accesible locally. Then reverse proxy to it, and provide TLS offload (i.e. HTTPS) from a web server already running on your server. * Or: Run Worldwideportal from a container without enabling TLS (HTTPS), but set it up so it is only accesible locally. Then reverse proxy to it, and provide TLS offload (i.e. HTTPS) from a web server already running on your server.
* Or: Build Worldwideportal from source for complete flexibility and control, including the ability to apply your own custom patches to it. * Or: Build Worldwideportal from source for complete flexibility and control, including the ability to apply your own custom patches to it.
# Option 1: Simple but less flexible installation ## Option 1: Simple but less flexible installation
## Create a configuration file ### Create a configuration file
Make a new directory - we'll call it `/etc/worldwideportal`, but you can put it wherever you like, on the system where Worldwideportal will run. Make a new directory - we'll call it `/etc/worldwideportal`, but you can put it wherever you like, on the system where Worldwideportal will run.
@ -122,7 +122,7 @@ To switch to a certificate recognised by browsers, edit `/etc/worldwideportal/wo
Connect to it again to check that everything works. Connect to it again to check that everything works.
# Option 2: Providing your own certificate ## Option 2: Providing your own certificate
Follow option 1, except delete the entire section of `/etc/worldwideportal/worldwideportal.toml` starting at `[tls.acme]`. Follow option 1, except delete the entire section of `/etc/worldwideportal/worldwideportal.toml` starting at `[tls.acme]`.
@ -130,7 +130,7 @@ Before starting the server, copy your PEM-formatted X.509 certificate (including
Whenever you rotate the certificate (e.g. from Certbot or similar), copy the new files over these files, and tell worldwideportal to reload its configuration with `kill -HUP $(pidof worldwideportal-server)` from your certificate renewal hook (or manually). This won't disconnect users who are connected. Whenever you rotate the certificate (e.g. from Certbot or similar), copy the new files over these files, and tell worldwideportal to reload its configuration with `kill -HUP $(pidof worldwideportal-server)` from your certificate renewal hook (or manually). This won't disconnect users who are connected.
# Option 3: Using a reverse proxy ## Option 3: Using a reverse proxy
Follow the instructions in option 1, but leave delete the `[tls]` and `[tls.acme]` sections. You probably want to change the default port from 443 to avoid confusion, since in this case `worldwideportal` will speak plain HTTP. Follow the instructions in option 1, but leave delete the `[tls]` and `[tls.acme]` sections. You probably want to change the default port from 443 to avoid confusion, since in this case `worldwideportal` will speak plain HTTP.
@ -152,7 +152,7 @@ location /ws/ {
} }
``` ```
# Option 4: Building from source ## Option 4: Building from source
You can also build worldwideportal from source. You can also build worldwideportal from source.
@ -162,24 +162,24 @@ It has two parts:
Both parts are in Rust, and you'll need [Trunk](https://trunkrs.dev/) to build the frontend. Both parts are in Rust, and you'll need [Trunk](https://trunkrs.dev/) to build the frontend.
## Check out the repositories ### Check out the repositories
``` ```
git clone https://git.blastmud.org/blasthavers/worldwideportal-server git clone https://git.blastmud.org/blasthavers/worldwideportal-server
git clone https://git.blastmud.org/blasthavers/worldwideportal git clone https://git.blastmud.org/blasthavers/worldwideportal
``` ```
## Install Rustup and Cargo ### Install Rustup and Cargo
Follow the instructions from [https://doc.rust-lang.org/cargo/getting-started/installation.html](https://doc.rust-lang.org/cargo/getting-started/installation.html). Follow the instructions from [https://doc.rust-lang.org/cargo/getting-started/installation.html](https://doc.rust-lang.org/cargo/getting-started/installation.html).
The quickest option there is to run `curl https://sh.rustup.rs -sSf | sh`. The quickest option there is to run `curl https://sh.rustup.rs -sSf | sh`.
## Install trunk ### Install trunk
`cargo install --locked trunk` `cargo install --locked trunk`
## Build worldwideportal-server ### Build worldwideportal-server
``` ```
pushd worldwideportal-server pushd worldwideportal-server
@ -187,7 +187,7 @@ cargo build --release
popd popd
``` ```
## Build worldwideportal ### Build worldwideportal
``` ```
pushd worldwideportal pushd worldwideportal
@ -195,7 +195,7 @@ trunk build --release
popd popd
``` ```
## Use the server ### Use the server
Your worldwideportal-server binary is available in `worldwideportal-server/target/release/worldwideportal-server`. Your worldwideportal-server binary is available in `worldwideportal-server/target/release/worldwideportal-server`.