The website is designed to be able to require very little to no backend and is open source. The entire site is downloadable and can be deployed to work from your local machine, or be installed to a local or hosted web server for your own or your group’s ease of access.
This is for running the code from your local PC (or server) without the need of internet connection.
img folder into the same folder as the 5eTools development files. It should be at the same level as other folders like data or js.If you want to run the site from a local workstation, the following steps are provided to help those unfamiliar with how to setup a local webservice. Any webservice SHOULD suffice, but those listed are simple enough.
devd.exe file to the 5etools folder you extracted before. the one that contains the js folder.Tip for Windows
You can quickly open the terminal in a specific folder if you Shift-Right Click it and choose “Open Powershell/command line window here”
".\devd.exe" . and press Enter. Do not forget the period at the end!You should be able to access the site, as long as you keep the command window open. Whenever you want to stop it, just close the window.
If you don’t want to mess with the console every time you start the site, you can create a batch file to do it for you.
devd.exe file to:"C:/path/to/5eTools/devd.exe" "/path/to/5eTools"
.batpython -m http.server
python -m SimpleHTTPServer if using Python 2.x.You may wish to specify a port at the end of the command
py -m http.server 8080.
If you specify a port other than the default 80, you will need to include that in your localhost URL, e. g. http://localhost:8080.
npm install http-server -g. This will install the necesary packages to run the website.npm run serve:devYou can find the docker image and its links in the code’s repository, under Packages.
Place the provided contents in a docker-compose.yml file inside a directory of some sort dedicated to this task and run all commands from inside that directory.
version: "3"
services:
5etools:
image: <docker image url here> # set this to the current latest version.
restart: unless-stopped
ports:
- "8080:80" # where 8080 is the port on the machine and 80 is the internal port of the container. ie change 8080 to change which port you want to access the webserver at.
The following is a basic tutorial to use docker-compose.
# start the stack
docker-compose up -d
# stop the stack
docker-compose stop
# delete the stack
docker-compose down
# view logs for the stack
docker-compose logs
# run the container
docker run -p 8080:80 --restart unless-stopped --name someuniquename <docker image url here>
# stop the container
docker container stop someuniquename
# delete the container
docker container rm someuniquename
# logs for the container
docker container logs someuniquename
If you want to modify the files contained in the image in some way, clone the repo, change the files however you want, and build the container.
# clone the repo
git clone <repo url here>
# build the image
docker build -t imagename:version .
# run the image using the command in the Docker section changing ghcr.io/5etools-mirror-1/5etools:latest to imagename:version
Port
80is the containers internal port
The
.dockerignorefile ignores all new files by default, unless they match explictly allowed patterns. If you add a new file make sure it will be found by the existing patterns in the.dockerignorefile. To add a new pattern/file in the container add this line!pattern/file.