Giter Club home page Giter Club logo

docker-openvpn's Introduction


[English] [ะ ัƒััะบะธะน]

Build Status Build Status Build Time Docker Pulls Gitter chat GitHub

๐Ÿ”Docker-OpenVPN

Out of the box stateless openvpn server docker image which starts in just a few seconds and doesn't require presistent storage. To get it running, just copy & paste the snippet below and follow instructions in your terminal:

docker run --name dockovpn --cap-add=NET_ADMIN \
-p 1194:1194/udp -p 80:8080/tcp \
-e HOST_ADDR=$(curl -s https://api.ipify.org) \
alekslitvinenk/openvpn

To get more detailed information, go to Quick Start tutorial or watch video.

Website

https://dockovpn.io

GitHub Repo:

https://github.com/alekslitvinenk/docker-openvpn

DockerHub Repo:

https://hub.docker.com/r/alekslitvinenk/openvpn

Docker Tags

Tag Description
latest This tag is added to every newly built version be that v#.#.# or v#.#.#-regen-dh
v#.#.# Standard fixed release version, where {1} is major version, {2} - minor and {3} is a patch. For instance, v1.1.0
v#.#.#-regen-dh Release version with newly generated Deffie Hellman security file. In order to keep security high this version is generated every hour. Tag example - v1.1.0-regen-dh
dev Development build which contains the most recent changes from the active development branch (master)

Container commands

After container was run using docker run command, it's possible to execute additional commands using docker exec command. For example, docker exec <container id> ./version.sh. See table below to get the full list of supported commands.

Command Description Parameters Example
./version.sh Outputs full container version, i.e Dockovpn v1.2.0 docker exec dockovpn ./version.sh
./genclient.sh Generates new client configuration z โ€” Optional. Puts newly generated client.ovpn file into client.zip archive.

zp paswd โ€” Optional. Puts newly generated client.ovpn file into client.zip archive with password pswd
docker exec dockovpn ./genclient.sh

docker exec dockovpn ./genclient.sh z

docker exec dockovpn ./genclient.sh zp 123

๐Ÿ“บ Video Guide


๐Ÿš€ Quick Start

Prerequisites:

  1. Any hardware or vps server running Linux. You should have administrative rights on this machine.
  2. Docker installation on your server.
  3. Public ip address assigned to your server.

1. Run docker-openvpn

Copy & paste the following command to run docker-openvpn:

docker run --cap-add=NET_ADMIN \
-p 1194:1194/udp -p 80:8080/tcp \
-e HOST_ADDR=$(curl -s https://api.ipify.org) \
--name dockovpn alekslitvinenk/openvpn

If everything went well, you should be able to see the following output in your console:

Sun Jun  9 08:56:11 2019 Initialization Sequence Completed
Sun Jun  9 08:56:12 2019 Client.ovpn file has been generated
Sun Jun  9 08:56:12 2019 Config server started, download your client.ovpn config at http://example.com:8080/
Sun Jun  9 08:56:12 2019 NOTE: After you download you client config, http server will be shut down!

2. Get client configuration

Now, when your docker-openvpn is up and running you can go to <your_host_public_ip>:8080 on your device and download ovpn client configuration. As soon as you have your config file downloaded, you will see the following output in the console:

Sun Jun  9 09:01:15 2019 Config http server has been shut down

Import client.ovpn into your favourite openvpn client. In most cases it should be enough to just doubleclick or tap on that file.

3. Connect to your docker-openvpn container

You should be able to see your newly added client configuration in the list of available configurations. Click on it, connection process should initiate and be established withing few seconds.

Congratulations, now you're all set and can safely browse the internet.

Persisting configuration

There's a possibility to persist generated files on in volume storage. Run docker with

-v openvpn_conf:/etc/openvpn

Other resources

Contrubition Guidelines
Code Of Conduct
Release Guideline
License Agreement

docker-openvpn's People

Contributors

alekslitvinenk avatar romansavrulin avatar valfaw avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.