outline-br

Simple JavaScript module for listing & changing generated keys locally on Outline Manager.

Install

$ npm install outline-br

Usage

First you need to back up your old Outline (shadowbox) server.

For Ubuntu: Backup access.txt and persisted-state folder in /opt/outline folder.

Restore it to the same location in new server after installing Outline.

const keys = require("@rahmanow/outline-br");

// list without changing ip
keys('https://outline-management-api-url');


//Example Output:
// Anny -> ss://[email protected]:3422
// Batyr -> ss://[email protected]:3425
// Mike -> ss://[email protected]:2323
// Rodger -> ss://[email protected]:443
// Azat -> ss://[email protected]:3422
// Claire -> ss://[email protected]:3422
// ...
// ...


// list with new ip
keys('https://outline-management-api-url', '87.65.43.21');

// Example Output with new IP
// Anny -> ss://[email protected]:3422
// Batyr -> ss://[email protected]:3425
// Mike -> ss://[email protected]:2323
// Rodger -> ss://[email protected]:443
// Azat -> ss://[email protected]:3422
// Claire -> ss://[email protected]:3422
// ...
// ...

When it is used?

It can be used various reasons. The main idea was tracking the data usage of the Outline VPN users. If your server has limited free bandwidth, and you want to limit the users' bandwidth, you need to track it. In case (which happens a lot in my country) ISP blocks the IP, you will have to reinstall the server with new IP. And send the keys to the users again. Backup the Outline Manager from the server, restore it to new server and use "outline-br" to list all the new keys with the names.

Coming Soon

• Auto generate mass keys.
• Using major functions of Outline Manager App from terminal.
• Web App: Authorise a user to generate own key.
• Backup & Restore