outliner

README

Outliner

CLI tool for Auto setup and deploy outline VPN

$ outliner --help
Auto setup & deploy tool for outline VPN server

Usage:
  outliner [command]

Available Commands:
  create      create a Server
  deploy      deploy outliner to Server
  destroy     destroy a Server
  help        Help about any command
  inspect     inspect Server
  list        list following [command]
  version     show outliner version

Flags:
  -F, --file string   config file (default is $HOME/.outliner/.env)
  -h, --help          help for outliner

Use "outliner [command] --help" for more information about a command.

Contents

• Download
• Setup
  • 1. Get API_TOKEN
  • 2. Make a .env config file
  • 3. Generate ssh key
  • 4. Ready to go
• Usage
• Configurations
  • config by .env file
  • config by Environment Variables
  • Support TOKEN_NAME
  • Support configuration source
• Support Cloud(IaaS)
• Development and Build

Download

download from latest release

Setup

1. Get API_TOKEN

get API_TOKEN from cloud providers you want, like Linode, DigitalOcean and etc.

2. Make a .env config file

write the API_TOKEN to .env file whith TOKEN_NAME like this. Reference the Support TOKEN_NAME below.

3. Generate SSH key

outliner support auto generate ssh key, if Not found id_rsa and id_rsa.pub in $HOME/.ssh/. ssh library package outliner use, is implement by golang.org run any command in outliner will do this after asking.

$ outliner help
Continue to Generate New ssh key? (y/n) [y]:

To generate key by yourself, see Generating a new SSH key and adding it to the ssh-agent

4. Ready to go

• open terminal, go directory whrere you download outliner
• maybe should add execute permission to binary (linux or mac)
• $ ./build/outliner_{OS}

Configurations

config by .env file

• ~/.outliner/.env

TOKEN_NAME_1 = TOKEN_VALUE_1
TOKEN_NAME_2 = TOKEN_VALUE_2
...

config by Environment Variables

$ {TOKEN_NAME_1}={TOKEN_VALUE_1} outliner [command]

Support TOKEN_NAME

Provider	TOKEN_NAME
Linode	LINODE_TOKEN
Linode	LINODE_CLI_TOKEN
Linode	LINODE_API_TOKEN
Digitalocean
Vultr

find full list in pkg/cloud/{ProviderNmae}/activator.go as below

var tokenNames = []string{
    "SUPPORTED_TOKEN_NAME_1",
    "SUPPORTED_TOKEN_NAME_2",
    ...
}

Support configuration source

outliner Support the following configuration source (list by Precedence order)

1. with flag -F, --file {FILE_PATH}
2. Environment variables
3. .env file at ~/.outliner/
4. .env file at ~/
5. .env file at ./

Support Cloud(IaaS)

• Linode
• DigitalOcean (WIP)
• Vultr (WIP) ...

Development and Build

1. install depend package

$ make mod

1. build binary

$ make build

1. run

$ ./build/outliner_$(go env GOOS)