Initial commitHEADmaster

1 files changed, 50 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e196363
--- /dev/null
+++ b/README.md
@@ -0,0 +1,50 @@
+# EphermalVPN
+
+EphermalVPN is a simply set of scrits to manage an aphermal vpn for scaleway
+provider.
+
+For the moment you MUST read each script to understand what each script do !
+
+This set of scripts use the set of scripts of 
+[setup-ipsec-vpn](https://github.com/hwdsl2/setup-ipsec-vpn).
+
+The objectif is to automate the installation and the configuration of a VPN on
+the server and on the client. For now the server and the client are configured
+to use a IPsec/LTP VPN.
+
+# Script list
+
+## install_srv.sh
+This script is the first script to lauch, it set the psk key, the user and the
+password, create and launch a vpn server and configure the client.
+
+**NOTE: This script launch the script of configure the client who is on 
+archlinux ! If your an note on archlinux, edit the script before !**
+
+## server_instal.sh.sample
+This script install and configure the VPN server. For now it just install the
+IPsec/LTP VPN via the set of the of 
+[setup-ipsec-vpn](https://github.com/hwdsl2/setup-ipsec-vpn). No rule of
+security is added !
+
+**NOTE: The variable `VPN_IPSEC_PSK`, `VPN_USER` and `VPN_PASSWORD` are
+modified by the install_srv.sh script !**
+
+## client_config_archlinux.sh.sample
+This script configure the client. You must run `client_install_archlinux.sh`
+before for install the required package. And this two script works only with
+archlinux.
+
+## server_remove.sh
+This script stop and remove a server. Only this script have some comments if
+you don't used correctly.
+
+Usage exemple:
+
+```sh
+sh remove_server.sh 429ab1dc
+```
+
+## server_create.sh
+This script is an old test script for create a server. But some command are
+replaced by the scaleway API. It not used for now.