Outline VPN Installation Guide

Outline is a modern, fast, and secure VPN solution developed by Jigsaw (a subsidiary of Google). It uses the Shadowsocks protocol and provides an easy-to-use management app for configuring your VPN server and clients. This guide will walk you through installing and configuring Outline on your server.

TIP

Our hosting clients have access to a fully automated Outline installation script during initial service ordering, or through scripts in the VM control panel. After the script finishes, you'll receive connection details for Outline Connect and management details for Outline Manager.

Prerequisites

Before starting, ensure you have:

• A server running a supported Linux distribution (Debian/Ubuntu, RHEL/CentOS/AlmaLinux/Rocky/Fedora)
• Root or sudo access to the server
• Basic knowledge of command line operations
• The server's public IP address
• A device to install the Outline Manager app (Windows, macOS, or Linux)

Installation

Automatic Installation for Hosting Clients

During Service Order

In the order menu, select "Outline" from the dropdown menu, complete the order and wait for service processing to finish.

Immediately after server activation, you will receive an email containing your Outline Manager URL and access credentials. You can use these to connect to your server through the Outline client, or manage your VPN server through the Outline Manager app.

Through the VM Panel

Go to the VM control panel, navigate to the management of the desired server, expand the "Menu" in the top right corner and select "Run script".

In the dialog, select the "Outline" option and enable "Send email associated with script".

After installation is complete, you will receive an email with your Outline Manager URL and access credentials. You can then use these to connect to your server through the Outline client, or manage your VPN server through the Outline Manager app.

Manual Installation

The installation process varies depending on your Linux distribution. Make sure to use the correct commands for the installation process.

Ubuntu/Debian

# Update package list
apt-get update -y

# Install required dependencies
apt-get install -y curl jq

RHEL/CentOS/AlmaLinux/Rocky/Fedora

# Install EPEL repository (if not already installed)
yum install -y epel-release
# OR for newer systems:
dnf install -y epel-release

# Install required dependencies
yum install -y curl jq
# OR for newer systems:
dnf install -y curl jq

Run the Official Outline Installer

The Outline project provides an official installation script that handles all the complex setup:

# Download and run the official Outline installer
curl -sS https://raw.githubusercontent.com/Jigsaw-Code/outline-server/master/src/server_manager/install_scripts/install_server.sh | bash

This script will:

• Install Docker and Docker Compose
• Set up the Outline server with Shadowsocks
• Configure the management interface
• Generate server certificates
• Start all necessary services

Installing the Outline Manager App

After installation, you'll need to install the Outline Manager app to configure your VPN server and create client access keys.

Download the Outline Manager App

Download the Outline Manager app for your platform:

• Windows: Download from official website
• macOS: Download from official website or Mac App Store
• Linux: Download from official website

Finding Your Server Configuration

The installation script will output a JSON configuration containing your server details. Look for output similar to:

{
  "apiUrl": "https://your-server-ip:port/your-server-id",
  "certSha256": "your-certificate-hash"
}

Copy these details for later.

If you can't find the server configuration, you can check the installation logs:

# Check the installation log for the server configuration
cat /var/log/outline-install.log | grep -E "(apiUrl|certSha256)"

Adding Your Server to Outline Manager

1. Install and launch the Outline Manager app
2. Choose "Set up Outline anywhere" in the provider selection
3. Paste your server configuration (the JSON containing apiUrl and certSha256) copied in the previous step
4. Set a server name (optional but recommended)
5. Click "Done" to add your server

After successful setup, the app will take you straight to your server dashboard:

Server Configuration

Initial Server Setup

Once your server is added to the Outline Manager app, you can configure it:

1. Set a server name - Choose a descriptive name for your VPN server
2. Set data limits - Optionally set monthly data limits for users

Creating Access Keys

Access keys are what clients use to connect to your Outline server. Each key represents a unique connection.

Creating Your First Access Key

1. Click "Add new key" in the Outline Manager app
2. Choose a name for the key (e.g., "My Phone", "Laptop")
3. Set data limits (optional)
4. Click "Add" to create the key

The system will immediately generate a unique access URL (starting with ss://) that clients will use to connect.

With Outline Manager you can:

• Rename keys
• Monitor traffic usage per key
• Set or reset data limits

To view/share a key, click the Share icon next to it, and the access key will be shown.

Provide it to your users, or use it in the next step.

Client Configuration

Installing Outline Connect

Outline provides official client applications called "Outline Connect" for various platforms.

Windows Installation

1. Download Outline Connect from the official website or the direct mirror
2. Run the installer and follow the setup wizard
3. Launch Outline Connect after installation

macOS Installation

1. Download Outline Connect from the Mac App Store or the official website
2. Install the application following the standard macOS installation process
3. Launch Outline Connect from your Applications folder

Linux Installation

1. Download the AppImage from the official mirror
2. Make it executable: chmod +x Outline-Client.AppImage
3. Run the application

Mobile Devices (Android/iOS)

1. Download the app:
   • For Android: Google Play Store or direct APK
   • For iOS: App Store
2. Install and launch the Outline Connect app

Connecting to Your VPN

1. Open Outline Connect on your device
2. Add a server by clicking the "+" button
3. Enter the access key (the ss:// URL you copied from the Outline Manager)
4. Give the connection a name (optional)
5. Click "Add" to save the connection
6. Connect by clicking the toggle switch next to your server

Verification

Check Server Status

You can verify that your Outline server is running properly:

# Check if Docker containers are running
docker ps | grep outline

# Check Outline server logs
docker logs outline-server

# Check if the management interface is accessible
curl -k https://localhost:your-port/your-server-id

Test the VPN Connection

1. Connect to your VPN using Outline Connect
2. Check your IP address - Visit check-host.net to verify your IP has changed
3. Test internet connectivity - Ensure you can browse the web normally
4. Check connection stability - Leave the connection active for a while to test stability

Firewall Configuration

Outline uses Shadowsocks protocol and typically runs on a custom port. Make sure your firewall allows the necessary traffic:

For UFW (Ubuntu/Debian):

# Allow the Outline port (check the actual port in your manager URL)
ufw allow 443/tcp
ufw allow 80/tcp

# If using a custom port, replace 443 with your actual port
ufw allow CUSTOM/tcp

For firewalld (RHEL/CentOS):

# Allow the Outline port
firewall-cmd --permanent --add-port=443/tcp
firewall-cmd --permanent --add-port=80/tcp
firewall-cmd --reload

# If using a custom port, replace 443 with your actual port
firewall-cmd --permanent --add-port=CUSTOM/tcp
firewall-cmd --reload

Managing Users and Access

Adding Multiple Users

1. Create additional access keys in the Outline Manager app
2. Share the access URLs with your users
3. Set individual data limits for each user if needed
4. Monitor usage through the management app

User Management Features

• Usage statistics - View data usage for each access key
• Connection monitoring - See which keys are currently connected
• Data limits - Set and enforce monthly data limits
• Key management - Rename, modify, or delete access keys

Troubleshooting

Common Issues

1. Cannot connect to server in Outline Manager:

   • Check if the server is running: docker ps | grep outline
   • Verify the server configuration (apiUrl and certSha256) is correct
   • Ensure the port is open in your firewall
   • Check if the server is accessible from your network

2. Client cannot connect:

   • Verify the access key URL is correct
   • Check if the server port is accessible
   • Ensure the client app is up to date
   • Try regenerating the access key

3. Slow connection speeds:

   • Check server resources (CPU, memory, bandwidth)
   • Verify your internet connection speed
   • Try connecting from a different network
   • Check if there are any bandwidth limits set

4. Outline Manager app shows errors:

   • Check Docker container logs: docker logs outline-server
   • Restart the Outline service: docker restart outline-server
   • Verify disk space and system resources
   • Try removing and re-adding the server in the Outline Manager app

Useful Commands

# Check Outline server status
docker ps | grep outline

# View server logs
docker logs outline-server

# Restart Outline server
docker restart outline-server

# Check system resources
htop
df -h

# Test network connectivity
ping 8.8.8.8
curl -I https://www.google.com

Network Debugging

# Check if the Outline port is listening
netstat -tlnp | grep :your-port

# Test port connectivity
telnet your-server-ip your-port

# Check firewall status
ufw status
# OR
firewall-cmd --list-all

Security Considerations

1. Keep access keys secure: Never share access keys publicly and rotate them regularly
2. Use strong passwords: Set a strong password for the Outline Manager
3. Regular updates: Keep your server and Outline software updated
4. Monitor usage: Regularly check the management interface for unusual activity
5. Backup configuration: Keep backups of your server configuration
6. Network security: Ensure your server is properly secured and firewalled

Advanced Configuration

Custom Port Configuration

If you need to change the default port:

1. Stop the Outline server: docker stop outline-server
2. Edit the configuration in the Docker compose file
3. Restart the server: docker start outline-server
4. Update firewall rules to allow the new port

SSL Certificate Configuration

For production use, consider replacing the self-signed certificate with a proper SSL certificate:

1. Obtain an SSL certificate (Let's Encrypt recommended)
2. Update the Outline configuration to use the new certificate
3. Restart the Outline server

Conclusion

You now have a fully functional Outline VPN server! The Outline Manager app makes it easy to manage users, monitor usage, and configure your VPN server. Users can connect using the official Outline Connect applications on any platform.

Remember to:

• Keep your access keys secure
• Regularly monitor usage and performance
• Keep your server and software updated
• Back up your configuration regularly

The Outline Manager app provides an intuitive interface for all server management tasks, making it easy to maintain and scale your VPN service.