taigrr/nats.docs
1
0
Fork 0
mirror of https://github.com/taigrr/nats.docs synced 2025-01-18 04:03:23 -08:00
Code Issues Projects Releases Wiki Activity

updating docs

Browse Source
This commit is contained in:
ainsley
2019-05-29 11:47:21 -05:00
parent 0f32311e3a
commit d35e3cb277
151 changed files with 5644 additions and 658 deletions
Download Patch File Download Diff File Expand all files Collapse all files

69
docs/nats_server/installation.html
View File

@@ -1044,9 +1044,9 @@
</li>
<li class="chapter " data-level="4.5.1.2.5" data-path="jwt_auth.html">
<li class="chapter " data-level="4.5.1.2.5" data-path="accounts.html">
<a href="jwt_auth.html">
<a href="accounts.html">
Accounts
@@ -1057,7 +1057,20 @@
</li>
<li class="chapter " data-level="4.5.1.2.6" data-path="auth_timeout.html">
<li class="chapter " data-level="4.5.1.2.6" data-path="jwt_auth.html">
<a href="jwt_auth.html">
JWTs
</a>
</li>
<li class="chapter " data-level="4.5.1.2.7" data-path="auth_timeout.html">
<a href="auth_timeout.html">
@@ -2289,17 +2302,48 @@
<section class="normal markdown-section">
<h2 id="nats-server-installation"><a name="nats-server-installation" class="plugin-anchor" href="#nats-server-installation"><i class="fa fa-link" aria-hidden="true"></i></a>NATS Server Installation</h2>
<p>NATS philosophy is simplicity. Installation is just decompressing a zip file and copying the binary to an appropriate directory; you can also use your favorite package manager.</p>
<p>NATS philosophy is simplicity. Installation is just decompressing a zip file and copying the binary to an appropriate directory; you can also use your favorite package manager. Here&apos;s a list of different ways you can install or run NATS:</p>
<ul>
<li><a href="#installing-via-docker">Docker</a></li>
<li><a href="#installing-on-kubernetes-with-nats-operator">Kubernetes</a></li>
<li><a href="#installing-via-a-package-manager">Package Manager</a></li>
<li><a href="#downloading-a-release-build">Release Zip</a></li>
<li><a href="installing-from-the-source">Development Build</a></li>
</ul>
<h3 id="installing-via-docker"><a name="installing-via-docker" class="plugin-anchor" href="#installing-via-docker"><i class="fa fa-link" aria-hidden="true"></i></a>Installing via Docker</h3>
<p>With docker you can install the server easily without scattering binaries and other artifacts on your system. The only pre-requisite is to <a href="https://docs.docker.com/install" target="_blank">install docker</a>.</p>
<pre class="language-"><code>&gt; docker pull nats:latest
latest: Pulling from library/nats
Digest: sha256:0c98cdfc4332c0de539a064bfab502a24aae18ef7475ddcc7081331502327354
Status: Image is up to date for nats:latest
docker.io/library/nats:latest
</code></pre><p>To run NATS on Docker:</p>
<pre class="language-"><code>&gt; docker run -p 4222:4222 -ti nats:latest
[1] 2019/05/24 15:42:58.228063 [INF] Starting nats-server version #.#.#
[1] 2019/05/24 15:42:58.228115 [INF] Git commit [#######]
[1] 2019/05/24 15:42:58.228201 [INF] Starting http monitor on 0.0.0.0:8222
[1] 2019/05/24 15:42:58.228740 [INF] Listening for client connections on 0.0.0.0:4222
[1] 2019/05/24 15:42:58.228765 [INF] Server is ready
[1] 2019/05/24 15:42:58.229003 [INF] Listening for route connections on 0.0.0.0:6222
</code></pre><p>More information on <a href="../nats_docker/">containerized NATS is available here</a>.</p>
<h3 id="installing-on-kubernetes-with-nats-operator"><a name="installing-on-kubernetes-with-nats-operator" class="plugin-anchor" href="#installing-on-kubernetes-with-nats-operator"><i class="fa fa-link" aria-hidden="true"></i></a>Installing on Kubernetes with NATS Operator</h3>
<p>Installation via the NATS Operator is beyond this tutorial. You can read about the <a href="https://github.com/nats-io/nats-operator" target="_blank">NATS
Operator</a> here.</p>
<h3 id="installing-via-a-package-manager"><a name="installing-via-a-package-manager" class="plugin-anchor" href="#installing-via-a-package-manager"><i class="fa fa-link" aria-hidden="true"></i></a>Installing via a Package Manager</h3>
<p>On Windows:</p>
<pre class="language-"><code>&gt; choco install nats-server
</code></pre><p>On Mac OS:</p>
<pre class="language-"><code>&gt; brew install nats-server
</code></pre><p>Via Docker:</p>
<pre class="language-"><code>&gt; docker pull nats-server:latest
</code></pre><h3 id="installing-a-release-build"><a name="installing-a-release-build" class="plugin-anchor" href="#installing-a-release-build"><i class="fa fa-link" aria-hidden="true"></i></a>Installing A Release Build</h3>
</code></pre><p>To test your installation (provided the executable is visible to your shell):</p>
<pre class="language-"><code>&gt; nats-server
[41634] 2019/05/13 09:42:11.745919 [INF] Starting nats-server version 2.0.0
[41634] 2019/05/13 09:42:11.746240 [INF] Listening for client connections on 0.0.0.0:4222
...
[41634] 2019/05/13 09:42:11.746249 [INF] Server id is NBNYNR4ZNTH4N2UQKSAAKBAFLDV3PZO4OUYONSUIQASTQT7BT4ZF6WX7
[41634] 2019/05/13 09:42:11.746252 [INF] Server is ready
</code></pre><h3 id="downloading-a-release-build"><a name="downloading-a-release-build" class="plugin-anchor" href="#downloading-a-release-build"><i class="fa fa-link" aria-hidden="true"></i></a>Downloading A Release Build</h3>
<p>You can find the latest release of nats-server <a href="https://github.com/nats-io/nats-server/releases/latest" target="_blank">here</a>.</p>
<p>Download the zip file matching your systems architecture, and unzip. For this example, assuming version 2.0.0 of the server, and a Linux AMD64:</p>
<p>Download the zip file matching your systems architecture, and unzip. For this example, assuming version 2.0.0 of the server and a Linux AMD64:</p>
<pre class="language-"><code>&gt; curl -L https://github.com/nats-io/nats-server/releases/download/v2.0.0/nats-server-v2.0.0-linux-amd64.zip -o nats-server.zip
&gt; unzip nats-server.zip -d nats-server
@@ -2311,11 +2355,10 @@ Archive: nats-server.zip
&gt; cp nats-server-v2.0.0darwin-amd64/nats-server /usr/local/bin
</code></pre><h3 id="installing-from-the-source"><a name="installing-from-the-source" class="plugin-anchor" href="#installing-from-the-source"><i class="fa fa-link" aria-hidden="true"></i></a>Installing from the source</h3>
<p>If you have go installed, installing the binary is easy:</p>
<p>If you have Go installed, installing the binary is easy:</p>
<pre class="language-"><code>&gt; go get github.com/nats-io/nats-server
</code></pre><p>This mechanism will install a build of <a href="https://github.com/nats-io/nats-server" target="_blank">master</a>, which almost certainly will not be a released version. If you are a developer and want to play with the latest, this is the easiest way of obtaining it. </p>
<h2 id="testing-your-installation"><a name="testing-your-installation" class="plugin-anchor" href="#testing-your-installation"><i class="fa fa-link" aria-hidden="true"></i></a>Testing Your Installation</h2>
<p>To test your installation (provided the executable is visible to your shell):</p>
</code></pre><p>This mechanism will install a build of <a href="https://github.com/nats-io/nats-server" target="_blank">master</a>, which almost certainly will not be a released version. If you are a developer and want to play with the latest, this is the easiest way. </p>
<p>To test your installation (provided the $GOPATH/bin is set):</p>
<pre class="language-"><code>&gt; nats-server
[41634] 2019/05/13 09:42:11.745919 [INF] Starting nats-server version 2.0.0
[41634] 2019/05/13 09:42:11.746240 [INF] Listening for client connections on 0.0.0.0:4222
@@ -2365,7 +2408,7 @@ Archive: nats-server.zip
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Installing","level":"4.1","depth":1,"next":{"title":"Running","level":"4.2","depth":1,"path":"nats_server/running.md","ref":"nats_server/running.md","articles":[{"title":"Window Service","level":"4.2.1","depth":2,"path":"nats_server/windows_srv.md","ref":"nats_server/windows_srv.md","articles":[]}]},"previous":{"title":"Advanced Connect and Custom Dialer in Go","level":"3.8.4","depth":2,"path":"developer/tutorials/custom_dialer.md","ref":"developer/tutorials/custom_dialer.md","articles":[]},"dir":"ltr"},"config":{"plugins":["prism","-highlight","include-html","toggle-chapters","anchors"],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"prism":{"lang":{"ascii":"markup","text":"markup"}},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"include-html":{},"fontsettings":{"theme":"white","family":"sans","size":2},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"anchors":{},"toggle-chapters":{}},"theme":"default","author":"The NATS Maintainers","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"NATS","gitbook":"*","description":"Administrative, developer and conceptual documentation for the NATS messaging system."},"file":{"path":"nats_server/installation.md","mtime":"2019-05-22T19:29:21.313Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-05-24T21:09:44.530Z"},"basePath":"..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Installing","level":"4.1","depth":1,"next":{"title":"Running","level":"4.2","depth":1,"path":"nats_server/running.md","ref":"nats_server/running.md","articles":[{"title":"Window Service","level":"4.2.1","depth":2,"path":"nats_server/windows_srv.md","ref":"nats_server/windows_srv.md","articles":[]}]},"previous":{"title":"Advanced Connect and Custom Dialer in Go","level":"3.8.4","depth":2,"path":"developer/tutorials/custom_dialer.md","ref":"developer/tutorials/custom_dialer.md","articles":[]},"dir":"ltr"},"config":{"plugins":["prism","-highlight","include-html","toggle-chapters","anchors"],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"prism":{"lang":{"ascii":"markup","text":"markup"}},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"include-html":{},"fontsettings":{"theme":"white","family":"sans","size":2},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"anchors":{},"toggle-chapters":{}},"theme":"default","author":"The NATS Maintainers","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"NATS","gitbook":"*","description":"Administrative, developer and conceptual documentation for the NATS messaging system."},"file":{"path":"nats_server/installation.md","mtime":"2019-05-29T16:43:54.848Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-05-29T16:45:48.381Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>