search

doodlezucc / dungeonclub

A cool little website for playing Dungeons & Dragons together!
https://dungeonclub.net
MIT License
66 stars 11 forks source link

QUESTION: how would one go to self-host this project? #5

Closed ghost closed 2 years ago

ghost commented 2 years ago

greetings,

i'm delving into the wonders of self-hosting this amazingly simple tool, but i'm not by any means an expert in web-technologies.

i'm wondering if it is possible to compile everything into one executable for easier time trying to self host it, at least in non-server pcs.

thank you for your time nevertheless and great work ! ~ joao

doodlezucc commented 2 years ago

Hey, glad you like it! I think it's certainly possible to self-host Dungeon Club. The whole project is written in Dart, which allows compiling into native machine code on Windows, macOS and Linux.

The tricky part in self-hosting lies in getting two (optional) backend services to work:

  1. If you want to use the integrated audio player, background music playlists may need to be downloaded (~500 MB). This would require both youtube-dl and ffmpeg to be installed and on your PATH. (Ambience sound effects will work nonetheless, as they are static files included in this repo.)
  2. If you want users to be able to create an account, an OAuth 2.0 client is needed to enable mail services. A client can be created and applied to the server with the help of running <path to server.exe> mail.

Note that your server would still be able to run and perform normally without these services. If you only plan to self-host to play with your friends, no e-mail registration should be required, naturally! I'll be working out a few things to make it easier to build and run the VTT on your local machine and will update this thread soon. Stay tuned!

Cheers

doodlezucc commented 2 years ago

Alright, good news - the first batch of automatically generated builds can be downloaded from the GitHub Releases tab right now! Each of the attached zip/tgz archive files include both a copy of all web/frontend files and a freshly built dedicated server for Windows, MacOS or Linux, ready to launch. :shipit:

Your operating system is, however, most likely to complain when trying to run the executable server.exe. This is due to me not wanting to go broke on code signing certificates which cost a fortune on a monthly basis. Hopefully this won't be much of a problem for self-hosters.

I've also spent some time polishing the Readme to include information about development and self-hosting. If any questions come up, I'd be happy to help!

ghost commented 1 year ago

alright, thank you for your hard work!

(hopefuly this comment wont open the issue again)