Installation guide — development preview

Set up your server.
Then add your applications.

You will need a Linux server, administrator access and a computer with a browser. Initial setup uses Terminal or PowerShell; application management then moves to the browser.

This guide is a draft. The public installer isn’t available yet. Explore the steps, but wait to rent a server until a release is ready.

A Mac, Windows or Linux computer A fresh Linux server with administrator access No domain name needed for the recommended route
Review server requirements
01

Choose a server

A rented server stays on when your laptop is closed. You pay the hosting provider directly.

These are direct links to official guides, not affiliate links. Check that your chosen server meets the release requirements; these links do not mean every provider has been tested.

Example starting size

Ubuntu 24.04Operating system4 cores · 8 GBCPU & memory100 GB SSDStorage

A suggested starting size, not a measured guarantee. Your choice of apps and the size of your library affect what you need.

Already have a server, or using a computer at home?

Use a fresh Linux installation intended for ScholarServer. Don’t reinstall a machine that contains important work. For a home server, find its local IP address in your router’s device list. You do not need to open your home router’s ports for the recommended Tailscale route.

02

Connect from your computer

Use SSH to connect to a server without a screen. Run the installer there, then open its private setup page on your computer.

Find the server’s IP address in your hosting dashboard. You’ll also need its login username and the password or SSH key you chose when creating it.

Keep passwords and private keys on your computer. This website never needs them.
  1. Open Terminal on your Mac or Linux computer, or PowerShell on Windows.
  2. Replace USERNAME and SERVER_IP below with your server’s details, then run the command.
ssh -o ExitOnForwardFailure=yes -L 127.0.0.1:8088:127.0.0.1:8088 USERNAME@SERVER_IP

This connects to your server and keeps the installer page private. It does not install ScholarServer. Keep this window open until permanent access is working.

What happens when I connect for the first time?

You may be asked to trust the server’s fingerprint. Compare it with the fingerprint shown through your provider’s server console before accepting. Then enter your server password if prompted; it’s normal for no characters to appear while typing.

If the connection times out, check the server address and that your provider allows SSH on port 22 from your computer. Do not open port 8088 to the internet.

03

Install and configure ScholarServer

Once a public release is available, run its installation command in the connected server terminal. Review the plan before confirming. The installer then prints a one-time setup link; open it in your computer’s browser and keep it private.

  1. Name the installation.You can change this later.
  2. Choose how to connect.The recommended option is “Private dashboard + AI connection”. Install Tailscale on each computer or phone that will use the dashboard, and sign in to the same network as the server. Keep the SSH connection open until the dashboard address works.
  3. Install applications.Open Applications → Catalog, choose an app and select Install. Complete its Configuration steps. Find it later under Installed. Set up a backup before adding important data and keep the recovery key somewhere other than the server.
No public installation command yet.

A signed public release and installation checks are still required. This guide is not a complete installation procedure until that release is available.

Questions

Access and maintenance

Does ScholarServer host my research for me?

No. You run it on your own hardware or rent a server from a provider. You remain responsible for the server, its costs and your backups.

Do I need to be comfortable with the terminal?

For this installation route, you’ll use Terminal on macOS or Linux, or PowerShell on Windows, to connect and run the installer. After that, everyday setup and management happen in the browser.

Can I use ChatGPT or Claude with it?

Yes, with a public AI connection configured separately from your private dashboard. Tailscale Funnel provides an address without a domain and is a beta service. In AI connections, copy the MCP server URL into your AI application, sign in and test a request. Your AI service may require its own subscription, and requests may send research data to that provider.

What if I don’t want Tailscale?

Advanced setup supports Cloudflare Tunnel or HTTPS through a reverse proxy for public AI access. These routes require your own domain and additional setup. With “AI connection only”, the dashboard stays local: use SSH forwarding or local server access to administer ScholarServer.