Outline Admin

Outline Admin is a web interface for the Outline Manager API, providing a simple and user-friendly UI for managing VPN servers.

Note

The previous PHP/Laravel version of this project has been moved to the OutlineAdminLaravel repository.

Table of Contents

1. Added Features
2. Installation
   • Docker
   • Docker Compose
   • NodeJS
3. Development
4. Admin Password
5. Donation
6. Screenshots

Added Features

• Expiration dates for Access Keys.
• QR codes for Access Keys.
• Dynamic Access Keys.
• Access Key prefix.

Installation

Docker

Before installing Outline Admin, ensure that Docker and Docker Compose are installed on your machine. Use the following commands to start the container:

docker run -d -p 3000:3000 --name outline-admin -v ./oa_data:/app/data --restart unless-stopped amro045/outline-admin:latest

Docker Compose

To simplify the installation, you can use a Docker Compose file:

wget -O docker-compose.yml https://raw.githubusercontent.com/AmRo045/OutlineAdmin/main/docker-compose.yml

docker compose up -d

NodeJS

To run this project on your machine, ensure you have Node.js v20 or later and npm v10 or later installed. Follow the steps below to set up Outline Admin using Node.js:

Step 1: Prepare the project files

git clone https://github.com/AmRo045/OutlineAdmin.git
cd OutlineAdmin
cp .env.example .env

Step 2: Install dependencies

npm install

Step 3: Create the database

npx prisma migrate deploy 
npx prisma generate

Step 4: Build the project

npm run compile
npm run setup 
npm run build

Step 5: Start the application

cd .next/standalone
node server.js

Development

Follow the steps below:

Step 1: Prepare the project files

git clone https://github.com/AmRo045/OutlineAdmin.git
cd OutlineAdmin
cp .env.example .env

Step 2: Install dependencies

npm install

Step 3: Create the database

npx prisma db push
npx prisma generate

Step 4: Build the project

npm run compile
npm run setup

Step 5: Start the application

npm run dev

Admin Password

To update the admin user password, use one of the following commands.

For Docker containers:

docker exec -it outline-admin npm run password:change "your new password"

For non-Docker setup:

npm run password:change "your new password"

Donation

If you find this project useful and would like to support its development, consider making a donation. Your support is greatly appreciated!

BTC

bc1qjmnnw4779ntv08uuqmpqnx7hqmygl08z4z500a

USDT

0xCcF2117F837b16fbc0FbDe0178De0a2aCbfadC58

TON

UQByW0gL9r89D4oFagC3ZRCEctIoh6XjHu7zv5xU2wcPVATT

ETH

0xCcF2117F837b16fbc0FbDe0178De0a2aCbfadC58

Screenshots