Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mathieuancelin committed Jan 15, 2018
1 parent 8f7aea7 commit effb1bc
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 34 deletions.
8 changes: 4 additions & 4 deletions docs/manual/cli.html
Original file line number Diff line number Diff line change
Expand Up @@ -216,12 +216,12 @@
<h1><a href="#rust-cli" name="rust-cli" class="anchor"><span class="anchor-link"></span></a>Rust CLI</h1>
<p>Otoroshi provides a command line tool to command Otoroshi instances.</p>
<h2><a href="#download" name="download" class="anchor"><span class="anchor-link"></span></a>Download</h2>
<p>First, download the Otoroshi CLI depending on your operating system :</p>
<pre class="prettyprint"><code class="language-sh">wget -q --show-progress https://dl.bintray.com/maif/binaries/linux-otoroshicli/latest/otoroshicli
<p>first, download the Otoroshi CLI depending on your operating system</p>
<pre class="prettyprint"><code class="language-sh">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
</code></pre>
<h2><a href="#usage" name="usage" class="anchor"><span class="anchor-link"></span></a>Usage</h2>
<p>The documentation is not written yet, but you can explore the cli usage using the help flag <code>-h</code></p>
Expand Down
6 changes: 3 additions & 3 deletions docs/manual/getotoroshi/frombinaries.html
Original file line number Diff line number Diff line change
Expand Up @@ -218,10 +218,10 @@ <h1><a href="#from-binaries" name="from-binaries" class="anchor"><span class="an
<p>If you want to download the last version of Otoroshi and its CLI, you can grab them from the release page of the Otoroshi github page :</p>
<p>Go to <a href="https://github.com/MAIF/otoroshi/releases">https://github.com/MAIF/otoroshi/releases</a> or get it from our bintray repository :</p>
<ul>
<li><a href="https://dl.bintray.com/maif/binaries/otoroshi.jar/latest/otoroshi.jar">https://dl.bintray.com/maif/binaries/otoroshi.jar/latest/otoroshi.jar</a></li>
<li><a href="https://dl.bintray.com/maif/binaries/otoroshi-dist/latest/otoroshi-dist.zip">https://dl.bintray.com/maif/binaries/otoroshi-dist/latest/otoroshi-dist.zip</a></li>
<li><a href="https://dl.bintray.com/maif/binaries/otoroshi.jar/1.0.0/otoroshi.jar">https://dl.bintray.com/maif/binaries/otoroshi.jar/1.0.0/otoroshi.jar</a></li>
<li><a href="https://dl.bintray.com/maif/binaries/otoroshi-dist/1.0.0/otoroshi-dist.zip">https://dl.bintray.com/maif/binaries/otoroshi-dist/1.0.0/otoroshi-dist.zip</a></li>
</ul>
<p>and get the last version of the <code>otoroshi-x.x.x.zip</code> file or <code>otoroshi-x.x.x.jar</code> file.</p>
<p>and get the last version of the <code>otoroshi-dist.zip</code> file or <code>otoroshi.jar</code> file</p>
<div class="nav-next">
<p><strong>Next:</strong> <a href="../getotoroshi/fromdocker.html">From docker</a></p>
</div>
Expand Down
16 changes: 3 additions & 13 deletions docs/manual/getotoroshi/fromdocker.html
Original file line number Diff line number Diff line change
Expand Up @@ -219,19 +219,9 @@ <h1><a href="#from-docker" name="from-docker" class="anchor"><span class="anchor
<p>first, fetch the last Docker image of Otoroshi :</p>
<pre class="prettyprint"><code class="language-sh">docker pull maif-docker-docker.bintray.io/otoroshi
</code></pre>
<p>then just run it :</p>
<pre class="prettyprint"><code class="language-sh">docker run -p &quot;8080:8080&quot; otoroshi
</code></pre>
<p>you can also pass useful args like :</p>
<pre><code>docker run -p &quot;8080:8080&quot; otoroshi -Dconfig.file=/home/user/otoroshi.conf -Dlogger.file=./home/user/otoroshi.xml
</code></pre>
<p>If you want to provide your own config file, you can read <a href="../firstrun/configfile.html">the documentation about config files</a></p>
<p>You can also provide some ENV variable using the <code>--env</code> flag to customize your Otoroshi instance, the list of possible ENV variables is available <a href="../firstrun/env.html">here</a>.</p>
<p>You can use a volume to provide configuration like :</p>
<pre class="prettyprint"><code class="language-sh">docker run -p &quot;8080:8080&quot; -v &quot;/home/user/oto/conf:/usr/app/otoroshi/conf&quot; otoroshi
</code></pre>
<p>You can also use a volume if you choose to use <code>leveldb</code> datastore like :</p>
<pre class="prettyprint"><code class="language-sh">docker run -p &quot;8080:8080&quot; -v &quot;/home/user/oto/data:/usr/app/otoroshi/leveldb&quot; otoroshi -Dapp.storage=leveldb
<p>you can also choose a specific version </p>
<pre class="prettyprint"><code class="language-sh">docker pull maif-docker-docker.bintray.io/otoroshi:1.0.0
docker pull maif-docker-docker.bintray.io/otoroshi:latest
</code></pre>
<div class="nav-next">
<p><strong>Next:</strong> <a href="../firstrun/index.html">First run</a></p>
Expand Down
13 changes: 6 additions & 7 deletions docs/manual/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -209,21 +209,20 @@
<div class="small-12 large-9 column" id="docs">
<h1><a href="#otoroshi" name="otoroshi" class="anchor"><span class="anchor-link"></span></a>Otoroshi</h1>
<p><strong>Otoroshi</strong> is a modern http reverse proxy with a thin layer of api management written in <a href="https://www.scala-lang.org/" target="_blank">Scala</a> and developped by the <a href="https://maif.github.io" target="_blank">MAIF OSS</a> team that can handle all the calls to and between your microservices without service locator and let you change configuration dynamicaly at runtime.</p>
<blockquote>
<p><em>The <a href="https://en.wikipedia.org/wiki/Gazu_Hyakki_Yagy%C5%8D#/media/File:SekienOtoroshi.jpg" target="blank">Otoroshi</a> is a large hairy monster that tends to lurk on the top of the torii gate in front of Shinto shrines. It&rsquo;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.</em></p>
</blockquote><div class="centered-img">
<p><a href="https://travis-ci.org/MAIF/otoroshi"><img src="https://travis-ci.org/MAIF/otoroshi.svg?branch=master" alt="Build Status" /></a> <a href="https://gitter.im/MAIF/otoroshi?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"><img src="https://badges.gitter.im/MAIF/otoroshi.svg" alt="Join the chat at https://gitter.im/MAIF/otoroshi" /></a> <a href="https://dl.bintray.com/maif/binaries/otoroshi.jar/latest/otoroshi.jar"> <img src="https://api.bintray.com/packages/maif/binaries/otoroshi.jar/images/download.svg" alt="Download" /> </a></p></div><div class="centered-img">

<p>The <a href="https://en.wikipedia.org/wiki/Gazu_Hyakki_Yagy%C5%8D#/media/File:SekienOtoroshi.jpg" target="blank">Otoroshi</a> is a large hairy monster that tends to lurk on the top of the torii gate in front of Shinto shrines. It&rsquo;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.</p><div class="centered-img">
<p><a href="https://travis-ci.org/MAIF/otoroshi"><img src="https://travis-ci.org/MAIF/otoroshi.svg?branch=master" alt="Build Status" /></a> <a href="https://gitter.im/MAIF/otoroshi?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"><img src="https://badges.gitter.im/MAIF/otoroshi.svg" alt="Join the chat at https://gitter.im/MAIF/otoroshi" /></a> <a href="https://dl.bintray.com/maif/binaries/otoroshi.jar/1.0.0/otoroshi.jar"> <img src="https://api.bintray.com/packages/maif/binaries/otoroshi.jar/images/download.svg" alt="Download" /> </a></p></div><div class="centered-img">
<img src="https://github.com/MAIF/otoroshi/raw/master/resources/otoroshi-logo.png" width="300"></img></div>
<h2><a href="#installation" name="installation" class="anchor"><span class="anchor-link"></span></a>Installation</h2>
<p>You can download the latest build of Otoroshi as a <a href="https://dl.bintray.com/maif/binaries/otoroshi.jar/latest/otoroshi.jar">fat jar</a>, as a <a href="https://dl.bintray.com/maif/binaries/otoroshi-dist/latest/otoroshi-dist.zip">zip package</a> or as a <a href="getotoroshi/fromdocker.html">docker image</a>.</p>
<p>You can download the latest build of Otoroshi as a <a href="https://dl.bintray.com/maif/binaries/otoroshi.jar/1.0.0/otoroshi.jar">fat jar</a>, as a <a href="https://dl.bintray.com/maif/binaries/otoroshi-dist/1.0.0/otoroshi-dist.zip">zip package</a> or as a <a href="getotoroshi/fromdocker.html">docker image</a>.</p>
<p>You can install and run Otoroshi with this little bash snippet</p>
<pre class="prettyprint"><code class="language-sh">wget -q --show-progress &#39;https://dl.bintray.com/maif/binaries/otoroshi.jar/latest/otoroshi.jar&#39;
<pre class="prettyprint"><code class="language-sh">wget -q --show-progress &#39;https://dl.bintray.com/maif/binaries/otoroshi.jar/1.0.0/otoroshi.jar&#39;
# run the following line if you want to use the admin UI in your browser
sudo echo &quot;127.0.0.1 otoroshi-api.foo.bar otoroshi.foo.bar otoroshi-admin-internal-api.foo.bar&quot; &gt;&gt; /etc/hosts
java -jar otoroshi.jar
</code></pre>
<p>or using docker</p>
<pre class="prettyprint"><code class="language-sh">docker run -p &quot;8080:8080&quot; maif-docker-docker.bintray.io/otoroshi
<pre class="prettyprint"><code class="language-sh">docker run -p &quot;8080:8080&quot; maif-docker-docker.bintray.io/otoroshi:1.0.0
</code></pre>
<p>now open your browser to <a href="http://otoroshi.foo.bar:8080/" target="_blank"><a href="http://otoroshi.foo.bar:8080/">http://otoroshi.foo.bar:8080/</a></a> and explore by yourself, if you want better instructions, just go to the <a href="quickstart.html">Quick Start</a> or directly to the <a href="getotoroshi/index.html">installation instructions</a></p>
<!---
Expand Down
14 changes: 7 additions & 7 deletions docs/manual/quickstart.html
Original file line number Diff line number Diff line change
Expand Up @@ -223,13 +223,13 @@ <h1><a href="#try-otoroshi-in-5-minutes" name="try-otoroshi-in-5-minutes" class=
<h2><a href="#the-elevator-pitch" name="the-elevator-pitch" class="anchor"><span class="anchor-link"></span></a>The elevator pitch</h2>
<p>Otoroshi is an awesome reverse proxy built with Scala that handles all the calls to and between your microservices without service locator and lets you change configuration dynamically at runtime.</p>
<h2><a href="#now-some-sh-" name="now-some-sh-" class="anchor"><span class="anchor-link"></span></a>Now some sh :)</h2>
<pre class="prettyprint"><code class="language-sh">wget -q --show-progress https://dl.bintray.com/maif/binaries/otoroshi.jar/latest/otoroshi.jar
<pre class="prettyprint"><code class="language-sh">wget -q --show-progress https://dl.bintray.com/maif/binaries/otoroshi.jar/1.0.0/otoroshi.jar
wget -q --show-progress https://raw.githubusercontent.com/MAIF/otoroshi/master/clients/cli/otoroshicli.toml
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 linux
wget -q --show-progress https://dl.bintray.com/maif/binaries/linux-otoroshicli/latest/otoroshicli
wget -q --show-progress https://dl.bintray.com/maif/binaries/linux-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

# Run the Otoroshi server
java -jar otoroshi.jar &amp;
Expand Down Expand Up @@ -301,11 +301,11 @@ <h2><a href="#i-dont-have-jdk-8-on-my-machine-but-i-have-docker-" name="i-dont-h
export LOCAL_IP_ADDRESS=999.999.999.999 # use your real local ip address here

wget -q --show-progress https://raw.githubusercontent.com/MAIF/otoroshi/master/clients/cli/otoroshicli.toml
wget -q --show-progress https://dl.bintray.com/maif/binaries/linux-otoroshicli/latest/otoroshicli
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

docker run -p &quot;$OTOROSHI_PORT:8080&quot; maif-docker-docker.bintray.io/otoroshi &amp;

Expand Down

0 comments on commit effb1bc

Please sign in to comment.