PretendoNetwork / .github

Information on the WIP Custom Nintendo WiiU/3DS/2DS server and service replacements
GNU Affero General Public License v3.0
921 stars 21 forks source link

[Request] Add a doc to install Pretendo server side #18

Open lautriva opened 1 year ago

lautriva commented 1 year ago

I want to selfhost the Pretendo Network on my own server but there seems its not documented anywhere

I see dockerfiles in repos but it's not clear how the repos/services relate to each other I barely understood that I need at least the account server + BOSS + a MongoDB instance

It would be good to have a new link in docs (something like https://pretendo.network/docs/server-install) explaining how services should be installed depending use cases example : what to install if someone need a single server for SMM1 / Splatoon / etc... (if its modular) or for a complete Nintendo replacement And how to patch the endpoints on the WiiU to redirect api calls to xxx.example.com instead of xxx.pretendo.network

jonbarrow commented 1 year ago

Adding complete documentation is planned for some point but is not in the roadmap at this time. This is because hosting the servers is rather complex at times, which you have discovered, and many things are actually optional. For example you do not need a BOSS server, we did not have one running live until very recently despite the repo being there since 2021

The servers, and their requirements, are ever changing and are not considered stable or ready for production use yet. Hence why detailed instructions for self-hosting is not available. The entire infrastructure could change in a 24 hour time span

Because so many things are optional, and a fully complete network setup requires many many many different pieces of software and servers running, these types of instructions will likely be very, very, long as well, which is an issue we have yet to completely solve. Right now self hosting is entirely possible if you have the experience to do so, and a complete set of documentation for the current version of the server infrastructure would likely only be useful for experienced developers as well

Once the servers are stable and considered production ready, and we have made a more user-friendly way to host them, then we will provide detailed instructions