Skip to content

Latest commit

 

History

History
35 lines (26 loc) · 1.66 KB

README.md

File metadata and controls

35 lines (26 loc) · 1.66 KB
Raw

Archipelago Web Docker

This repo contains a base to host an Archipelago Web Host using Docker Compose and SSL.

Getting started

  1. Clone Archipelago next to this file.
    1. git clone https://github.com/ArchipelagoMW/Archipelago.git
    2. This project has been tested and built with release 0.5.0, so it is suggested to checkout the 0.5.0 tag.
  2. If you plan on using the AlttP sprites, you need to provide the ROM Zelda no Densetsu - Kamigami no Triforce (Japan).sfc and place it next to this file.
  3. Run the init.sh to create the necessary directories and config files.
  4. Edit the docker-compose.yaml and config.yaml file to your liking, comments have been left in those files to guide you.
  5. Configure the .env file with the necessary information.
  6. Run docker compose up -d to start the server.

With the default config you should now be able to access the server using HTTPS on the host name you selected in the .env file, on port 4750, as well as connect to the Rooms on ports 50000-50100.

Home Network

If running this on your home network, you will need to forward the ports you selected in the .env file to the proper local IP of your machine.

You might also want to use a dynamic DNS service to have a domain name pointing to your home network.

Resources