If you notice any mistakes that need to be corrected, please reach out on Discord!
Petio supports two ways of connecting to a Mongo Database instance, locally or remote. We recommend the locally hosted MongoDB option.
- Download MongoDB Community Server here (make sure to choose version 4.4.7). That version only support Windows 10 and Server 2019. If you are on older OS, you need to download Community Server Edition v4.2.
- Install MongoDB using the default instructions on screen.
- Create a free cluster.
- Change the provider or region if you need to. It may take some time to create the cluster.
- After the cluster is made, click on connect and select MongoDB Compass and follow the instructions on screen.
First of all, download the Petio binaries from the downloads page and extract the zip file to a convenient location. (We recommend at the root of your
C:\Petio.) Note that the folders from the zip file (
viewsat the time of this writing) need to stay in the same folder as the binary itself.
- Extract the zip folder anywhere you want on your system. We recommend the root of your
C:\drive on a folder called
- Add the
NSSMfolder to your Windows Path.
- Go to Control Panel > System > Advanced System Settings
- Click on
Environment Variablesat the bottom
System Variablesscroll down until you see
Pathand double click on it
- To start the installion of Petio as a service type:
nssm install petio
- In the
Applicationtab make sure to specify the path to
Petio.exeand then click install service.
- To start the service use:
nssm start petio
- To check if the service is up and running use:
nssm status petio
- If you later wish to remove this service use:
nssm remove petio
- Shawl is portable, so place it anywhere you want on your system; we recommend the root of your
C:\drive in a folder called
- Open up an administrator command prompt and navigate to the directory where you placed Shawl. In our case:
- Create a service for Petio with Shawl using the command:
shawl.exe add --name Petio -- "C:\path\to\petio.exe"
- Then, start the Petio service like so (if you used PowerShell, replace
sc start Petio
- To stop Petio, use
sc stop Petio
- Once this is complete you can navigate to
http://<hostname>:7777/admin/to start configuring Petio or by viewing the
.logfile that Shawl created for Petio in the same directory where you placed Shawl.
You have the ability to serve Petio behind a reverse proxy. This is inherently more secure as you are not having to punch holes through your router's firewall or your Windows' firewall for every service you want to access remotely. By serving services behind a reverse proxy you are filtering all the traffic to ports 80/443. We recommend you read over our reverse proxy section. We have some helpful examples and there is even one specific to Windows.
- Stop Petio or the Petio service.
- Replace the "views" folder and "petio-win" with contents from the zip you downloaded.
- Now you're all done. Just fire up Petio again.