Quickstart
This is the Runetale quickstart guide on how to connect two devices to a secure private network. In this example, we will be using a Linux desktop as one device and an EC2 instance running on AWS as the other.
Currently, only installation using the CLI is supported. Desktop apps for macOS, Windows, and Linux will be released at the end of February 2023.
Step 1: Register your account with SSO login
Use your favorite SSO account to complete user registration. As of March 2023, Google, Microsoft, and GitHub are supported. IDaaS such as Okta and OneLogin are scheduled to be supported by April 2023. Check the SSO documentation for more information.
Step 2: Run the installation command
Once SSO login is successful, download the Runetale client app to your device.
curl -L https://pkgs.dotshake.com/debian/start.sh | sh
After the package is installed, check that the login URL is displayed on the terminal. If it is displayed correctly, click the URL to complete the session in your browser.
Your runetale ip => [100.72.93.185/16]
Successful login
2022-09-23T16:23:14.636+0900 info runetale up launched runetale daemon.
If Successful login
is displayed, the login was successful. Next, run sudo systemctl...
to confirm that the client is successfully launched from your device.
sudo systemctl status runetale.service
If the following message is displayed after execution, the system is working correctly.
● runetale.service - runetale daemon
Loaded: loaded (/etc/systemd/system/runetale.service; enabled; vendor preset: enabled)
Active: active (running) since Fri 2022-09-23 09:49:46 JST; 6h ago
Main PID: 175492 (runetaler)
Tasks: 22 (limit: 76989)
Memory: 8.1M
CGroup: /system.slice/runetale.service
└─175492 /usr/bin/runetaler up -daemon=false
Repeat the same setup for AWS EC2 instances. Once completed, the registration of the two devices that have successfully launched should be displayed on the dashboard.
Step 3: Check the connection status
Finally, check if peer-to-peer communication is working correctly by pinging
from your local device.
Linux desktop
ping 100.72.93.185
AWS EC2 instance
ping 100.72.8.203
Congratulations! The setup of Runetale is now complete! A peer-to-peer private network based on WireGuard has been configured in your environment.
Troubleshooting
If Runetale does not start correctly or if there are any problems, please contact support@runetale.com or open an issue on GitHub.