From effb1bc18fe6d776b8eac7ba1496336aa6d4d496 Mon Sep 17 00:00:00 2001 From: Mathieu ANCELIN Date: Mon, 15 Jan 2018 20:30:08 +0100 Subject: [PATCH] Update docs --- docs/manual/cli.html | 8 ++++---- docs/manual/getotoroshi/frombinaries.html | 6 +++--- docs/manual/getotoroshi/fromdocker.html | 16 +++------------- docs/manual/index.html | 13 ++++++------- docs/manual/quickstart.html | 14 +++++++------- 5 files changed, 23 insertions(+), 34 deletions(-) diff --git a/docs/manual/cli.html b/docs/manual/cli.html index ce78baff64..aea5f5f18f 100644 --- a/docs/manual/cli.html +++ b/docs/manual/cli.html @@ -216,12 +216,12 @@

Rust CLI

Otoroshi provides a command line tool to command Otoroshi instances.

Download

-

First, download the Otoroshi CLI depending on your operating system :

-
wget -q --show-progress https://dl.bintray.com/maif/binaries/linux-otoroshicli/latest/otoroshicli
+
first, download the Otoroshi CLI depending on your operating system

+
wget -q --show-progress https://dl.bintray.com/maif/binaries/linux-otoroshicli/1.0.0/otoroshicli
 # or if you use linux
-wget -q --show-progress https://dl.bintray.com/maif/binaries/mac-otoroshicli/latest/otoroshicli
+wget -q --show-progress https://dl.bintray.com/maif/binaries/mac-otoroshicli/1.0.0/otoroshicli
 # or if you use windows
-wget -q --show-progress https://dl.bintray.com/maif/binaries/win-otoroshicli/latest/otoroshicli.exe
+wget -q --show-progress https://dl.bintray.com/maif/binaries/win-otoroshicli/1.0.0/otoroshicli.exe
 

 
Usage

 
The documentation is not written yet, but you can explore the cli usage using the help flag -h

diff --git a/docs/manual/getotoroshi/frombinaries.html b/docs/manual/getotoroshi/frombinaries.html
index af589a9c7d..ed53b8a6b1 100644
--- a/docs/manual/getotoroshi/frombinaries.html
+++ b/docs/manual/getotoroshi/frombinaries.html
@@ -218,10 +218,10 @@ 
https://github.com/MAIF/otoroshi/releases or get it from our bintray repository :

 
-
and get the last version of the otoroshi-x.x.x.zip file or otoroshi-x.x.x.jar file.

+
and get the last version of the otoroshi-dist.zip file or otoroshi.jar file

 

 
Next: From docker

 

diff --git a/docs/manual/getotoroshi/fromdocker.html b/docs/manual/getotoroshi/fromdocker.html
index bf3c048cf9..792f3d14a2 100644
--- a/docs/manual/getotoroshi/fromdocker.html
+++ b/docs/manual/getotoroshi/fromdocker.html
@@ -219,19 +219,9 @@ 
docker pull maif-docker-docker.bintray.io/otoroshi
-

then just run it :

-
docker run -p "8080:8080" otoroshi
-
-

you can also pass useful args like :

-
docker run -p "8080:8080" otoroshi -Dconfig.file=/home/user/otoroshi.conf -Dlogger.file=./home/user/otoroshi.xml
-
-

If you want to provide your own config file, you can read the documentation about config files

-

You can also provide some ENV variable using the --env flag to customize your Otoroshi instance, the list of possible ENV variables is available here.

-

You can use a volume to provide configuration like :

-
docker run -p "8080:8080" -v "/home/user/oto/conf:/usr/app/otoroshi/conf" otoroshi
-
-

You can also use a volume if you choose to use leveldb datastore like :

-
docker run -p "8080:8080" -v "/home/user/oto/data:/usr/app/otoroshi/leveldb" otoroshi -Dapp.storage=leveldb
+
you can also choose a specific version 

+
docker pull maif-docker-docker.bintray.io/otoroshi:1.0.0
+docker pull maif-docker-docker.bintray.io/otoroshi:latest
 

 

 
Next: First run

diff --git a/docs/manual/index.html b/docs/manual/index.html
index e88712d44d..fe8322d106 100644
--- a/docs/manual/index.html
+++ b/docs/manual/index.html
@@ -209,21 +209,20 @@
 

 
Otoroshi

 
Otoroshi is a modern http reverse proxy with a thin layer of api management written in Scala and developped by the MAIF OSS team that can handle all the calls to and between your microservices without service locator and let you change configuration dynamicaly at runtime.

-

-  
The Otoroshi is a large hairy monster that tends to lurk on the top of the torii gate in front of Shinto shrines. It’s a hostile creature, but also said to be the guardian of the shrine and is said to leap down from the top of the gate to devour those who approach the shrine for only self-serving purposes.

-

-
Build Status Join the chat at https://gitter.im/MAIF/otoroshi  Download 

+
+
The Otoroshi is a large hairy monster that tends to lurk on the top of the torii gate in front of Shinto shrines. It’s a hostile creature, but also said to be the guardian of the shrine and is said to leap down from the top of the gate to devour those who approach the shrine for only self-serving purposes.

+
Build Status Join the chat at https://gitter.im/MAIF/otoroshi  Download 

 

 
Installation

-
You can download the latest build of Otoroshi as a fat jar, as a zip package or as a docker image.

+
You can download the latest build of Otoroshi as a fat jar, as a zip package or as a docker image.

 
You can install and run Otoroshi with this little bash snippet

-
wget -q --show-progress 'https://dl.bintray.com/maif/binaries/otoroshi.jar/latest/otoroshi.jar'
+
wget -q --show-progress 'https://dl.bintray.com/maif/binaries/otoroshi.jar/1.0.0/otoroshi.jar'
 # run the following line if you want to use the admin UI in your browser
 sudo echo "127.0.0.1    otoroshi-api.foo.bar otoroshi.foo.bar otoroshi-admin-internal-api.foo.bar" >> /etc/hosts
 java -jar otoroshi.jar
 

 
or using docker

-
docker run -p "8080:8080" maif-docker-docker.bintray.io/otoroshi
+
docker run -p "8080:8080" maif-docker-docker.bintray.io/otoroshi:1.0.0
 

 
now open your browser to http://otoroshi.foo.bar:8080/ and explore by yourself, if you want better instructions, just go to the Quick Start or directly to the installation instructions