TIP

We now offer $5/month hosting, you can get started with /buy_setup in our Discord serveropen in new window

Setting up Tovy

In this guide, we will walk you through both the installation and hosting process for Tovy. This page will also mention how to setup Tovy in a Railwayopen in new window project. df

For starter groups, we recommend using the Railway method as it is much easier to begin with. Larger groups can consider using Railway too! Just not the free tier.

Table of Content

Setting up Tovy in your server

WARNING

You are expected to know how to use the terminal as well as the NodeJS runtime. Tovy is not responsible for any user errors caused during the setup process, this includes money/playerbase losses, server crashes, et cetera.

As long as the corresponding platform is supported by the NodeJS runtimeopen in new window, Tovy can be installed and hosted for your fellow group members to use.

Prerequisites

  • A computer & a server
  • NodeJS 16+ installed with a package manager (Yarn, pnpm, or npm (included with NodeJS))
  • Git installed
  • Internet connection

Connecting to your server

You can download & setup Tovy in your computer first, then move Tovy back to your server. However, please be aware that we will be assuming you are doing all this in your server.

If you do not have direct access to your server, connect to the server via Secure Shell.

Downloading Tovy and required dependencies

Once you are in your server, type the following commands in your terminal session to download Tovy:

git clone https://github.com/ItsWHOOOP/tovy && cd tovy
1

After it finishes downloading, you should now be in Tovy's directory, run this command so the required dependencies for Tovy are installed:

npm install
1
pnpm install
1
yarn install
1

Setting up MongoDB

Tovy uses MongoDB to store users' data. Without one, Tovy will not be able to run properly as information will not be saved.

Head to MongoDBopen in new window and create/login your account.

Creating a new database

Once you have created your account, you should be greeted with a page that looks like this:

Just fill in the blanks and continue. After that, you should see a page like this:

Select either Dedicated or Shared tier. We recommend choosing the Dedicated tier if your group is relatively large.

After that, you will be prompted to a new page, asking for your preference in cloud providers:

Choose either AWS (Amazon Web Services), or Google Cloud. The location does not really matter much, but you should choose a location that is close to most of your group members.

And click Create Cluster

Setting up authorization

Now, you should see a new page asking for ways to authenticate the access to the database. Choose the Username and Password option, and pick something memorable yet safe.

Then, to the IP allowlist, type 0.0.0.0 into the IP address field for now, and click Add Enry

Finally, click Finish and Close. 🎉 You now have created a database for Tovy!

The URL

Once done, you should now see a page like this:

Click the Connect button, and choose the Connect your application option. After that, you will see this page:

Copy the URL, and replace <password> with the password you entered earlier for this database (Not to be confused with your MongoDB account password). You'll need this for the next part.

Setting up Tovy for the first time

Tovy requires some configuration before it can actually run. Configuring a system can be a hassle. However, luckily, we have built a tool to make configuration less painful to do.

To use the tool, just run:

node start
1

Setting up database

A prompt will appear asking for the URL to your MongoDB database. Simply paste the URL given by MongoDB when creating the database into the terminal, and press Enter/Return.

After that, Tovy should be running now.

Setting up login and your group

Once Tovy has started running, Tovy should reside in localhost:8080open in new window. Head to that page and setup login.

Password

Use an unique password. You should not use your own Roblox account's password for this!

Enter your Roblox username (Not to be confused with display name), as well as a password to log into Tovy. And click next.

Now, you should be able to see a new page, asking for your Roblox group's information. Enter your Group ID to the specified text field in order to proceed. To find your Group ID, head to your group first, the number sequence in the URL is the Group ID.

🎉 Setup should be complete now!

Serving Tovy

We will be using a tool to keep Tovy's instance always online –– pm2, this can be installed with your NodeJS package manager.

npm i -g pm2
1
pnpm i -g pm2
1
yarn global add pm2
1

Once that has been done, run the command:

pm2 start start.js
1

and it should start serving Tovy under the location localhost:8080open in new window. Point it to the server's IP and map it to a (sub)domain.

Setting up Tovy as a Heroku Dyno (free plan)

WARNING

Again, this solution is free, but if your group is relatively large, avoid the free plan and go for the paid tiers. You also have to add your credit card info to Heroku in order to allow the project to be up the whole month

Heroku offers a free tier (with credit card), if your group is small, we highly recommend using Heroku as a temporary platform.

Prerequisites

  • A credit card (if you are going for the paid tiers)
  • A Heroku account (with credit card linked)
  • A Github Account

Deploying Tovy onto Heroku

Before we start, go to the Tovy Github pageopen in new window, and hit the "fork" button and wait for it to finish. This is needed for when we update.

To begin, click the button below

Deployopen in new window

You should be presented with this screen. Type a name in that isn't taken, you can do something along the lines of "{group-name}-tovy" and hit 'Deploy app'.

Wait for it to install and build, it will error with missing MongoDB URI, but we will fix this later.

Once it is done, hit the "Manage App" button.

img

You will be thrown onto a project page. From here, press the "settings" tab on the menu.

Scroll down to "Reveal Config Vars" and click the button to show a empty variable table.

Grab a MongoDB URI by following thisopen in new window guide, and have that copied or in a notepad handy.

Create 2 variables in this tab, one called "PORT" with the value of 8080, and one with the name MONGO_URI with the URI you got earlier as the value.

Now, restart the dyno by clicking "more" and "restart all dynos".

Setting up Tovy for the first time

When Heroku finished building Tovy, you will see a "open app" button, click that button to view your instance. If you don't see the image below, wait for it to finish building, or ask for support in the Discord.

You should now see a page like this:

Password

Use an unique password. You should not use your own Roblox account's password for this!

Enter your Roblox username (Not to be confused with display name), as well as a password to log into Tovy. And click next.

Now, you should be able to see a new page, asking for your Roblox group's information. Enter your Group ID to the specified text field in order to proceed. To find your Group ID, head to your group first, the number sequence in the URL is the Group ID.

🎉 Setup should be complete now!

Setting up Tovy as a Railway project (free plan)

WARNING

Again, this solution is free, but if your group is relatively large, avoid the free plan and go for the paid tiers.

Railway offers a free tier, if your group is small, we highly recommend using Railway as a temporary platform.

Prerequisites

  • A GitHub account at least older than 30 days
  • A credit card (if you are going for the paid tiers)

Deploying Tovy onto Railway

To begin, click the button below

Deploy on Railwayopen in new window

Signup/login Railway with your GitHub account, make sure you have installed the Railway app into your account/organisation.

Once that has been done, you should see a page like this:

Check Private repo? and click Deploy.

Railway will now create a MongoDB database and complete the initial setup for you. Just wait until you see Success at the top.

Setting up Tovy for the first time

When deploying Tovy with Railway, the database creation is automatically done for you, there is no need to create a database manually or whatsoever.

When Railway finished building Tovy, you will see two links just below the build status text (psss: the one that says Success). Click the first one as the second is for development purposes only.

You should now see a page like this:

Password

Use an unique password. You should not use your own Roblox account's password for this!

Enter your Roblox username (Not to be confused with display name), as well as a password to log into Tovy. And click next.

Now, you should be able to see a new page, asking for your Roblox group's information. Enter your Group ID to the specified text field in order to proceed. To find your Group ID, head to your group first, the number sequence in the URL is the Group ID.

🎉 Setup should be complete now!