Skip to content

Installation

Iván edited this page May 2, 2023 · 6 revisions

MudClub: installation

Available for Linux systems - This should probably work also in other unices - there's an automated mudclub-installer. Tested to work on Debian 12 - appreciate any feedback on other installations (if any).

This installer performs the following operations:

  1. Pull the latest code from the main development branch to /srv/rails/mudclub.
  2. Create local mudclub user/group to manage the MudClub server.
  3. Create the required PostgreSQL database and user.
  4. Compile all necessary gems, assets and javascript packages.
  5. Configure nginx to serve MudClub pages externally via HTTPS.
  6. Copy to scripts to launch/stop/udpate the MudClub server to /usr/local/bin.
  7. Attempt to install a 'mudclub' system service - using pleaserun.

And voilá: you should be able to load your MudClub site by accessing the server's IP address with any web browser.

  • Default User: admin@mudclub.org
  • Default Password: mudclub-admin

Recommendations:

Domain Name

I strongly advise to get a valid DNS bound to access the server from the internet. Without this, you will only be able to connect to the MudClub server from the local network. A Dynamic DNS provider - such as FreeDNS is ok for this.

Make sure the server's network router is configured to forward HTTP (and HTTPs) requests from the internet to the MudClub server using the right TCP port (80 or 443, depending on your setup).

SSL encryption

If you wish to use SSL for *increased security in communications, you will need:

  • Valid DNS entry linked to your server - a Dynaminc DNS such as Afraid is ok.
  • Valid SSL certificates generated for your server & domain name - You can use the free LetsEncrypt service and their associated certbot to automate this and configure the nginx server.
  • Edit the nginx-mudclub-ssl template file to use your own domain name and overwrite /etc/nginx/sites/available/mudclub with it.
  • Restart nginx service and you should be using SSL to access your MudClub server!
Clone this wiki locally