Skip to content

Commit

Permalink
Add a note about dedicated servers.
Browse files Browse the repository at this point in the history
  • Loading branch information
Flone-dnb committed Jul 23, 2022
1 parent 3abfde2 commit 5c16d15
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,10 @@ In order to view reports you first need an account. Run `database_manager` that

The database that stores all information (reports, registered users, attachments and etc.) is called `database.db3` and it was generated when you run `server_moninor` for the first time. If you want to backup your database you just need to copy this `database.db3` file - there are no other dependencies, just make a copy of your `database.db3` file and that's it - that's your backup.

### About dedicated servers

For development or testing you can run server on your computer. When you want to share your game with somebody you need to make sure that the server's IP address is not going to change. So, let's consider this situation: you've added `server_monitor` to autostart in your computer, your game uses `localhost` as server IP (as we've seen in `reporter.gd`), you give your game to your friend and... he won't be able to send reports. Because the game sends reports to `localhost` (which is an alias for "this computer" or "local computer") your friend will send reports to his own computer but he does not have a running server and moreover this is not what we want. You may try to replace `localhost` with your public IP address but the thing is that when you restart your network router your provider usually gives you a new public IP address, some providers even give you new public IP address from time to time (at night for example) even if you wont restart your router. Thus, when you are ready to share your build with somebody you need to install the server to a dedicated server (a cloud server or "VPS/VDS" as they are called) that will have a static IP address which you will specify in your game. There a numerous "VPS/VDS" hosters with cheap hosting. For example, I use Hetzner's cloud server for this purpose. You don't need to have a Windows installed on your cloud server (there is no need for that, moreover Windows servers are usually more expensive), you can buy a cheap Linux server and install FBugReporter's server there (using `install_server.go`, because you will install it on Linux the script will also automatically add everything to autostart). The only things that you will need to do is install `Rust`, `Go` and `sqlite` packages, then run `install_server.go` and restart. Then you can use your server's static IP address in your game. Because setting up your own dedicated server might be a complicated task (if you've never tried this before or don't have any Linux experience) that can include multiple subtasks (like disabling root login, setting up a firewall, seting up a proper ssh connection and fail2ban) I will not talk about it here because it's a different topic. There are lots of tutorials on YouTube that will help you setup your own VPS/VDS. Once you have a Linux VPS/VDS, all you need to do is install `Rust`, `Go` and `sqlite` packages to the system and install FBugReporter's server using `install_server.go`.

# How to Update

If you want to update FBugReporter you need to update everything (reporter, client, server). For this just clone/download this repository with updated code and run each script again,
Expand Down

0 comments on commit 5c16d15

Please sign in to comment.