Getting started with Applications on ServerPrism

This guide walks you through setting up and configuring your chosen self-hosted application (5e Tools, Owncast, Rathole, or Yarr) on your ServerPrism server. It covers ordering, initial setup, configuration, and common issues.

Before you start

Ensure you have a ServerPrism account and are ready to deploy a new server or have an existing 'Applications' server ready for configuration.

Ordering on ServerPrism

1. Select a plan: Log in to ServerPrism and choose an 'Applications' server. We recommend starting with at least 2 GB RAM, scaling up to 12 GB for more demanding applications or higher user loads.
2. Choose a region: Select the server location closest to your primary users for optimal performance.
3. Deploy: Complete the order. Your server will begin provisioning automatically.

First boot

After ordering, your server will start provisioning. This process typically takes a few minutes. You can monitor its status via the ServerPrism panel at https://serverprism.com/dashboard. Once the server status shows as 'Running' and you see console output indicating the application has started, it's ready.

Connecting / inviting users

The method for connecting to your application depends on which one you've deployed:

• 5e Tools: Access your instance via the server's IP address and port (e.g., http://YOUR_SERVER_IP:PORT). The default port is usually 80 or 8080 for web applications. Check the 'Startup' tab in your ServerPrism panel for the APP_PORT variable if it's configurable.
• Owncast: Your Owncast instance will be accessible via http://YOUR_SERVER_IP:PORT. The default port for Owncast is 8080. You can also configure a custom domain or ServerPrism subdomain for easier access.
• Rathole: Rathole is a reverse proxy. Connecting involves configuring clients to connect through Rathole to your internal services. This requires setting up Rathole's server.toml and client configurations. It does not have a direct web interface for users.
• Yarr: Access your Yarr instance via http://YOUR_SERVER_IP:PORT. The default port is typically 8080.

To make access easier, you can attach a free subdomain to your server from your ServerPrism dashboard.

Configuration basics

Configuration for each application is typically done via environment variables in the ServerPrism panel's Startup tab or by editing specific configuration files using the File Manager or SFTP.

5e Tools

• Data Storage: 5e Tools uses a local database. Configuration is minimal. You can usually find settings related to data paths in startup variables if needed.
• Access: Ensure the APP_PORT variable in the Startup tab matches the port you are trying to access.

Owncast

• Configuration File: Owncast primarily uses config.yaml located in the application's data directory. You can edit this via the File Manager.
• Admin Access: The first time you access Owncast, you will be prompted to create an admin account. This is where you set your stream key and other settings.
• Startup Variables: Check the Startup tab for OWNCAST_DATABASE_PATH, OWNCAST_DATA_PATH, or OWNCAST_PORT to customize data locations or listening ports.

Rathole

• Configuration File: Rathole requires a server.toml file. This file defines the listening ports and the services it will proxy. You must edit this file to make Rathole functional.
  • Example server.toml (edit via File Manager):

  [server]
  bind_addr = "0.0.0.0:8000" # Server listening port
  
  [server.services.my_service]
  type = "tcp"
  token = "your_secret_token"
  bind_addr = "0.0.0.0:2222" # Port clients connect to
  remote_addr = "127.0.0.1:22" # Internal service Rathole forwards to
  

• Tokens: Ensure the token in server.toml matches the client's configuration for secure connection.

Yarr

• Configuration: Yarr's configuration is often managed through environment variables or a config.json file. Check the Startup tab for variables like YARR_PORT, YARR_DATABASE_PATH, or YARR_ADMIN_EMAIL.
• Initial Setup: The first time you access Yarr, you may need to go through an initial setup wizard to create an admin user and configure basic settings.

Common issues

1. Application not starting: Check the server console in the ServerPrism panel for error messages. Missing configuration files, incorrect environment variables, or port conflicts are common causes. Ensure all required files are present and correctly formatted.
2. Cannot access the web interface:
   • Verify the application is running and listening on the expected port (e.g., 8080).
   • Check your server's firewall rules (ServerPrism usually handles this, but ensure your application isn't trying to use a non-standard blocked port).
   • Confirm you are using the correct IP address and port in your browser. If using a domain, ensure DNS is correctly pointing to your server IP.
3. Rathole client not connecting: Double-check that the token in your server.toml matches the client's configuration. Ensure the bind_addr for the service in server.toml is correctly configured and accessible.
4. Slow performance: If your application is running slowly, consider upgrading your server plan for more RAM or CPU. You can do this from your ServerPrism customer dashboard.

If you encounter persistent issues, gather your server ID and relevant log output from the console and open a support ticket at https://serverprism.com/tickets.

Next steps

• Custom Domains: For a more professional setup, attach a custom domain or a free ServerPrism subdomain to your application from your ServerPrism dashboard.
• Runtime Switching: If you decide to switch to a different application (e.g., from Owncast to Yarr), you can do so easily via the Startup tab in your ServerPrism panel by selecting a new runtime. This will re-image your server with the new application.
• Advanced Configuration: Refer to the official documentation for your chosen application for advanced features, integrations, and customization options.