Outline VPN Server on a VPS: Manager Setup, Access Keys and Clients
Connect Outline Manager to your Outline server, create and limit access keys, share them with users and connect from Windows, macOS, Linux, Android and iPhone.
Outline is open-source VPN software based on the Shadowsocks protocol, built to get around network restrictions. It keeps setup simple for both the administrator and the people who use it.
When you order an Outline VPS, the Outline server is installed for you. It has no web panel: you manage it from the free Outline Manager app on your computer, and users connect with the Outline Client app.
- Operating system: Ubuntu 22.04
- Minimum server: 1 vCPU and 1 GB RAM
- Management: one SSH login as root to copy the management key, then Outline Manager
Find your login details
When your server is ready, we email you its IP address and the root password. The same details are in your client area, under the server’s information. In the commands below, replace SERVER_IP with your server’s IP address.
Copy the server’s management key
Connect to the server over SSH and show the management key. The output is one line of JSON, like the last line below:
Copy the whole line, including the curly braces. Anyone with this key can manage your server, so keep it private.
ssh root@SERVER_IP
cat /root/outline_api_key.txt
{"apiUrl":"https://SERVER_IP:PORT/SECRET","certSha256":"FINGERPRINT"}Connect Outline Manager
Outline Manager is the desktop app you use to run the server.
- Download Outline Manager for your computer from getoutline.org and install it.
- Open it and choose Set up Outline anywhere.
- In the second step, paste the management key you copied.
- Click Done.
The management screen opens with one access key already created.
Create and manage access keys
Each person gets their own access key. In Outline Manager you can:
- Create a key: click Add access key. Each key gets a unique ID.
- Rename a key: click its name, type a new one and press Enter.
- Share a key: click the share icon next to it and copy the key or the invitation.
- Limit a key’s data: click the icon next to it, set a monthly limit in GB and click Save.
- Delete a key: click the icon next to it and confirm.
Configure the server
Open the Settings tab in Outline Manager. There you can:
- Change the server’s name.
- Change the access port (54899 by default).
- Turn automatic updates on or off.
- Set a data limit for all keys at once.
- Remove the server from Outline Manager. This only removes it from the app; the server itself keeps running.
Install Outline Client
Users connect with Outline Client, available from getoutline.org for Windows, macOS, Linux, Android and iOS. Send them the download link together with their access key.
Add the server to Outline Client
There are two ways for a user to add the server:
- With a link: the user opens the access link you sent. Outline Client starts and adds the server by itself.
- By hand: the user opens Outline Client, clicks the + button, pastes the access key and clicks Confirm.
Connect and check the VPN
In Outline Client, click Connect to start the VPN and Disconnect to stop it.
To check the connection, open any “what is my IP” site: it should show your server’s IP address and location.
Get a server for this guide
Outline VPS comes ready with everything in this guide, from $7.50/mo billed yearly.
See Outline VPS plansTable of Contents
- 1.1. Find your login details
- 2.2. Copy the server’s management key
- 3.3. Connect Outline Manager
- 4.4. Create and manage access keys
- 5.5. Configure the server
- 6.6. Install Outline Client
- 7.7. Add the server to Outline Client
- 8.8. Connect and check the VPN
Explore More VPS Hosting Options
Find the right server for your project.
Start Your NodexVPS Today
Save 50% with yearly billing. No contract, cancel any time.