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 effb1bc commit 0f8ecd3
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docs/manual/cli.html
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@
<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>
<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/1.0.0/otoroshicli
Expand Down
6 changes: 3 additions & 3 deletions docs/manual/firstrun/run.html
Original file line number Diff line number Diff line change
Expand Up @@ -217,15 +217,15 @@
<h1><a href="#run-otoroshi" name="run-otoroshi" class="anchor"><span class="anchor-link"></span></a>Run Otoroshi</h1>
<p>Now you are ready to run Otoroshi. You can run the following command with some tweaks depending on the way you want to configure Otoroshi. If you want to pass a custom configuration file, use the <code>-Dconfig.file=/path/to/file.conf</code> flag in the following commands.</p>
<h2><a href="#from-zip-file" name="from-zip-file" class="anchor"><span class="anchor-link"></span></a>From .zip file</h2>
<pre class="prettyprint"><code class="language-sh">unzip otoroshi-vx.x.x.zip
<pre class="prettyprint"><code class="language-sh">unzip otoroshi-dist.zip
cd otoroshi-vx.x.x
./bin/otoroshi
</code></pre>
<h2><a href="#from-jar-file" name="from-jar-file" class="anchor"><span class="anchor-link"></span></a>From .jar file</h2>
<pre class="prettyprint"><code class="language-sh">java -jar otoroshi-vx.x.x.jar
<pre class="prettyprint"><code class="language-sh">java -jar otoroshi.jar
</code></pre>
<h2><a href="#from-docker" name="from-docker" class="anchor"><span class="anchor-link"></span></a>From docker</h2>
<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>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
Expand Down
7 changes: 5 additions & 2 deletions docs/manual/getotoroshi/fromdocker.html
Original file line number Diff line number Diff line change
Expand Up @@ -217,10 +217,13 @@
<h1><a href="#from-docker" name="from-docker" class="anchor"><span class="anchor-link"></span></a>From docker</h1>
<p>If your a Docker aficionado, Otoroshi is provided as a Docker image that your can pull directly from Official repos.</p>
<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
<pre class="prettyprint"><code class="language-sh">docker pull maif-docker-docker.bintray.io/otoroshi:1.0.0
# or with last snapshot
docker pull maif-docker-docker.bintray.io/otoroshi:latest
</code></pre>
<p>you can also choose a specific version </p>
<p>then just run it :</p>
<pre class="prettyprint"><code class="language-sh">docker pull maif-docker-docker.bintray.io/otoroshi:1.0.0
# or with last snapshot
docker pull maif-docker-docker.bintray.io/otoroshi:latest
</code></pre>
<div class="nav-next">
Expand Down
5 changes: 3 additions & 2 deletions docs/manual/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -209,8 +209,9 @@
<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>

<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">
<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/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>
Expand Down

0 comments on commit 0f8ecd3

Please sign in to comment.