Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kekeho/vpn4friends

VPN server for your friends
https://github.com/kekeho/vpn4friends

docker docker-compose openvpn vpn vpn-server

Last synced: 22 days ago
JSON representation

VPN server for your friends

Awesome Lists containing this project

README

        

# VPN4friends

知り合いの数人で利用することを想定した小規模なVPNサーバーシステムです。

## 概要

管理者は最小限のコマンドのみで簡単にVPNサーバーを立ち上げることができ、ユーザーも簡単にアカウントを作成出来るシステムです。
すべてのシステムはDockerコンテナで実行されます。

## 初期設定

まずは初期設定をする必要があります。
Posixシェルでinit.shを実行します。
流れに沿って必要な項目を入力してください。

```bash
sh init.sh
```

次に、docker-compose.ymlを書き換える必要があります。
CA_PASSをinit.shを実行した際に入力した値に書き換えてください。
EMAIL_TLS、EMAIL_HOST、EMAIL_HOST_USER、EMAIL_HOST_PASSWORD、EMAIL_PORTはお使いのメールサーバーを指定してください。

## 起動

```bash
docker-compose up
```

## 使い方

WEBブラウザからサーバーにアクセスすると、簡単にVPNアカウントを発行できます。
発行するとメールアドレス宛にOpenVPNのプロファイルが届きます。
その後クライアントをお使いのOSに合わせてダウンロードし、プロファイルを適用すればVPN接続が確立されます。

## その他

OpenVPNを使います。
Docker, Docker Composeを予め導入しておいてください。
サーバーの80、11451ポートを開放してください。
本ソフトウェア、ソースコードの使用で生じたすべての事柄に対して、責任を負いません。セキュリティ等にはお気をつけください。