mirror of
https://github.com/docker/docs.git
synced 2026-04-12 06:19:22 +07:00
603 lines
31 KiB
XML
603 lines
31 KiB
XML
<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
|
|
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
|
|
<channel>
|
|
<title>Kitematics on Docker Docs</title>
|
|
<link>http://localhost/kitematic/</link>
|
|
<description>Recent content in Kitematics on Docker Docs</description>
|
|
<generator>Hugo -- gohugo.io</generator>
|
|
<language>en-us</language>
|
|
<atom:link href="http://localhost/kitematic/index.xml" rel="self" type="application/rss+xml" />
|
|
|
|
<item>
|
|
<title>Creating a Local RethinkDB Database for Development</title>
|
|
<link>http://localhost/kitematic/rethinkdb-dev-database/</link>
|
|
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
|
|
|
<guid>http://localhost/kitematic/rethinkdb-dev-database/</guid>
|
|
<description>
|
|
|
|
<h1 id="kitematic-tutorial-creating-a-local-rethinkdb-database-for-development">Kitematic Tutorial: Creating a Local RethinkDB Database for Development</h1>
|
|
|
|
<p>In this tutorial, you will:</p>
|
|
|
|
<ul>
|
|
<li>Create a RethinkDB Container for Development</li>
|
|
<li>(Advanced) Clone a small Node.js application and write data into RethinkDB.</li>
|
|
</ul>
|
|
|
|
<h3 id="setting-up-rethinkdb-in-kitematic">Setting up RethinkDB in Kitematic</h3>
|
|
|
|
<p>First, if you haven&rsquo;t yet done so, <a href="../">download and start
|
|
Kitematic</a>. Once open, the app should look like
|
|
this:</p>
|
|
|
|
<p><img src="../kitematic/images/rethink-create.png" alt="Rethink create button" /></p>
|
|
|
|
<p>Click on the <em>Create</em> button of the <code>rethinkdb</code> image listing in the recommended
|
|
list as shown above. This will download &amp; run a RethinkDB container within a few
|
|
minutes. Once it&rsquo;s done, you&rsquo;ll have a local RethinkDB database up and running.</p>
|
|
|
|
<p><img src="../kitematic/images/rethink-container.png" alt="Rethink container" /></p>
|
|
|
|
<p>Let&rsquo;s start using it to develop a node.js app. For now, let&rsquo;s figure out which
|
|
IP address and port RethinkDB is listening on. To find out, click the <code>Settings</code>
|
|
tab and then the <code>Ports</code> section:</p>
|
|
|
|
<p><img src="../kitematic/images/rethink-ports.png" alt="Rethink create button" /></p>
|
|
|
|
<p>You can see there that for RethinkDB port <code>28015</code>, the container is listening on
|
|
host <code>192.168.99.100</code> and port <code>49154</code> (in this example - ports may be different
|
|
for you). This means you can now reach RethinkDB via a client driver at
|
|
<code>192.168.99.100:49154</code>. Again, this IP address may be different for you.</p>
|
|
|
|
<h3 id="advanced-saving-data-into-rethinkdb-with-a-local-node-js-app">(Advanced) Saving Data into RethinkDB with a local Node.js App</h3>
|
|
|
|
<p>Now, you&rsquo;ll create the RethinkDB example chat application running on your local
|
|
OS X system to test drive your new containerized database.</p>
|
|
|
|
<p>First, if you don&rsquo;t have it yet, <a href="http://nodejs.org/">download and install
|
|
Node.js</a>.</p>
|
|
|
|
<blockquote>
|
|
<p><strong>Note</strong>: this example needs Xcode installed. We&rsquo;ll replace it with something
|
|
with fewer dependencies soon.</p>
|
|
</blockquote>
|
|
|
|
<p>In your terminal, type:</p>
|
|
|
|
<pre><code> $ export RDB_HOST=192.168.99.100 # replace with IP from above step
|
|
$ export RDB_PORT=49154 # replace with Port from above step
|
|
$ git clone https://github.com/rethinkdb/rethinkdb-example-nodejs-chat
|
|
$ cd rethinkdb-example-nodejs-chat
|
|
$ npm install
|
|
$ npm start
|
|
</code></pre>
|
|
|
|
<p>Now, point your browser to <code>http://localhost:8000</code>. Congratulations, you&rsquo;ve
|
|
successfully used a RethinkDB container in Kitematic to build a real-time chat
|
|
app. Happy coding!</p>
|
|
|
|
<p><img src="../kitematic/images/rethinkdb-preview.png" alt="Rethink app preview" /></p>
|
|
</description>
|
|
</item>
|
|
|
|
<item>
|
|
<title>Frequently Asked Questions</title>
|
|
<link>http://localhost/kitematic/faq/</link>
|
|
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
|
|
|
<guid>http://localhost/kitematic/faq/</guid>
|
|
<description>
|
|
|
|
<h1 id="kitematic-frequently-asked-questions">Kitematic: Frequently Asked Questions</h1>
|
|
|
|
<h3 id="is-kitematic-open-source">Is Kitematic Open Source?</h3>
|
|
|
|
<p>Yes! Our source code is available on
|
|
<a href="https://github.com/kitematic/kitematic">GitHub</a>. Kitematic is open source
|
|
software released under the Apache 2.0 license.</p>
|
|
|
|
<h3 id="how-can-i-contribute-to-kitematic">How can I contribute to Kitematic?</h3>
|
|
|
|
<p>We always welcome (and deeply appreciate!) new contributions to the project. The
|
|
best way to start contributing to Kitematic is to review our doc on <a href="https://github.com/kitematic/kitematic/blob/master/CONTRIBUTING.md">contributing</a>.</p>
|
|
|
|
<h3 id="how-does-kitematic-work-with-docker">How does Kitematic work with Docker?</h3>
|
|
|
|
<p>Kitematic connects directly to a running instance of Docker and controls it via
|
|
the Docker Remote API.</p>
|
|
|
|
<h3 id="which-platforms-does-kitematic-support">Which platforms does Kitematic support?</h3>
|
|
|
|
<p>Right now Kitematic works on Mac OS X and Windows. Linux is planned in the
|
|
future. Review our product <a
|
|
href="https://github.com/kitematic/kitematic/blob/master/ROADMAP.md">roadmap</a>.</p>
|
|
|
|
<h3 id="why-does-kitematic-collect-usage-analytics-and-bug-reports">Why does Kitematic collect usage analytics and bug reports?</h3>
|
|
|
|
<p>Kitematic tracks anonymous errors and analytics to help understand why things go
|
|
wrong and to help understand how users are interacting with the app so we can
|
|
continuously make it better.</p>
|
|
|
|
<p>You can opt-out of this anytime via the in-app preferences.</p>
|
|
|
|
<h4 id="what-we-don-t-collect">What we DON&rsquo;T collect</h4>
|
|
|
|
<ul>
|
|
<li>Personal information: any information that would allow us to determine a
|
|
specific user of Kitematic</li>
|
|
<li>Information or data relating to code, containers or Docker images opened via
|
|
Kitematic.</li>
|
|
</ul>
|
|
|
|
<h4 id="what-we-do-collect">What we DO collect</h4>
|
|
|
|
<ul>
|
|
<li>Anonymous events for actions in the app. We never collect data associated with
|
|
events. For example:
|
|
|
|
<ul>
|
|
<li>User searched for images (but not what the search query was).</li>
|
|
<li>User created a container (but not which image, the name of the container or
|
|
any data involved)</li>
|
|
<li>User opened the preferences pane</li>
|
|
<li>User deleted a container</li>
|
|
</ul></li>
|
|
<li>Errors names, messages &amp; stack traces (scrubbed for user names)</li>
|
|
<li>Operating System, Kitematic and installed VirtualBox versions</li>
|
|
</ul>
|
|
|
|
<p>We&rsquo;d love to answer any more questions about this. Feel free to reach us at
|
|
kitematic@docker.com or to open an issue on GitHub.</p>
|
|
|
|
<h2 id="next-steps">Next Steps</h2>
|
|
|
|
<p>For information about known issues in the current release of Kitematic, take a
|
|
look at the <a href="../kitematic/known-issues/">Known issues</a>.</p>
|
|
</description>
|
|
</item>
|
|
|
|
<item>
|
|
<title>Kitematic</title>
|
|
<link>http://localhost/kitematic/</link>
|
|
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
|
|
|
<guid>http://localhost/kitematic/</guid>
|
|
<description>
|
|
|
|
<h1 id="kitematic">Kitematic</h1>
|
|
|
|
<p>Kitematic, the Docker GUI, runs on Mac OS X and Windows operating systems. Beginning with the 1.8 Docker release, you use the Docker Toolbox to install Kitematic. See the <a href="https://docs.docker.com/installation/mac">Mac OS X installation guide</a> or the <a href="https://docs.docker.com/installation/windows">Windows installation guide</a> for details on installing with Docker Toolbox.</p>
|
|
|
|
<p>For information about using Kitematic, take a look at the <a href="../kitematic/userguide/">User Guide</a>.</p>
|
|
</description>
|
|
</item>
|
|
|
|
<item>
|
|
<title>Kitematic User Guide: Intro & Overview</title>
|
|
<link>http://localhost/kitematic/userguide/</link>
|
|
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
|
|
|
<guid>http://localhost/kitematic/userguide/</guid>
|
|
<description>
|
|
|
|
<h1 id="kitematic-user-guide">Kitematic user guide</h1>
|
|
|
|
<h2 id="overview">Overview</h2>
|
|
|
|
<p>Kitematic is an open source project built to simplify and streamline using
|
|
Docker on a Mac or Windows (coming soon) PC. Kitematic automates the Docker
|
|
installation and setup process and provides an intuitive graphical user
|
|
interface (GUI) for running Docker containers. Kitematic integrates with
|
|
<a href="https://docs.docker.com/machine/">Docker Machine</a> to provision a VirtualBox VM
|
|
and install the Docker Engine locally on your machine.</p>
|
|
|
|
<p>Once installed, the Kitematic GUI launches and from the home screen you will be
|
|
presented with curated images that you can run instantly. You can search for any
|
|
public images on Docker Hub from Kitematic just by typing in the search bar.
|
|
You can use the GUI to create, run and manage your containers just by clicking
|
|
on buttons. Kitematic allows you to switch back and forth between the Docker CLI
|
|
and the GUI. Kitematic also automates advanced features such as managing ports
|
|
and configuring volumes. You can use Kitematic to change environment variables,
|
|
stream logs, and single click terminal into your Docker container all from the
|
|
GUI.</p>
|
|
|
|
<p>First, if you haven&rsquo;t yet done so, <a href="../">download and start
|
|
Kitematic</a>.</p>
|
|
|
|
<h2 id="container-list">Container list</h2>
|
|
|
|
<p>Kitematic lists all running and stopped containers on the left side, underneath
|
|
the &ldquo;New Container&rdquo; link.</p>
|
|
|
|
<p>The container list includes all containers, even those not started by Kitematic,
|
|
giving you a quick over-view of the state of your Docker daemon.</p>
|
|
|
|
<p>You can click on any container to view its logs (the output of the main container
|
|
process), restart, stop or exec <code>sh</code> in that container. See <a href="#working-with-a-container">Working with a
|
|
container</a> for more details.</p>
|
|
|
|
<h2 id="creating-a-new-container">Creating a new container</h2>
|
|
|
|
<p>The &ldquo;New Container&rdquo; page lets you search for and select from images on the Docker Hub.
|
|
When you&rsquo;ve found the image you want to run, you can click &ldquo;Create&rdquo; to pull, create,
|
|
and run the container.</p>
|
|
|
|
<p><img src="../kitematic/images/browse-images.png" alt="Nginx create" /></p>
|
|
|
|
<h2 id="working-with-a-container">Working with a container</h2>
|
|
|
|
<p>If you select a non-running container, either stopped, or paused, you will be able
|
|
to &ldquo;Restart&rdquo; or &ldquo;Stop&rdquo; the container using the icons. You can also view the entire
|
|
main container process&rsquo; output logs, and in the Settings section you can make
|
|
changes which will be used if you &ldquo;Restart&rdquo; this container.</p>
|
|
|
|
<p>By selecting a running container from the left list, you can see some state information
|
|
for your container - either a preview of the HTML output for a container that has a web
|
|
server, the main container process&rsquo; logs, and any container volumes that have been
|
|
configured.</p>
|
|
|
|
<p><img src="../kitematic/images/cli-redis-container.png" alt="Redis container in Kitematic" /></p>
|
|
|
|
<p>The summary page will show different things depending on the image metadata. If
|
|
a known &ldquo;web&rdquo; port (see below) is <code>EXPOSED</code>, then Kitematic assumes its a web page,
|
|
and will show a preview of the site at <code>/</code>. If other ports are exposed, then it
|
|
will show a list of those ports, and the Docker daemon IP and port they are mapped
|
|
to. If there are any <code>VOLUMES</code>, then these will be shown. At minimum, the summary
|
|
screen will show the main container process&rsquo; log output.</p>
|
|
|
|
<p>The currently detected &ldquo;web&rdquo; ports are, <code>80</code>, <code>8000</code>, <code>8080</code>, <code>3000</code>, <code>5000</code>,
|
|
<code>2368</code>, <code>9200</code>, and <code>8983</code>.</p>
|
|
|
|
<h3 id="viewing-container-logs">Viewing container logs</h3>
|
|
|
|
<p>You can view the entire main container process&rsquo; log output either by clicking on the &ldquo;Logs&rdquo;
|
|
preview image, or by clicking on the &ldquo;Logs&rdquo; tab.</p>
|
|
|
|
<p>You can then scroll through the logs from the current running container. Note that
|
|
if you make changes to the container settings, then the container will be restarted,
|
|
so this will reset this log view.</p>
|
|
|
|
<h3 id="starting-a-terminal-in-a-container">Starting a terminal in a container</h3>
|
|
|
|
<p>The &ldquo;Terminal&rdquo; icon at the top of the container summary will <code>docker exec sh &lt;your container&gt;</code>.
|
|
This will allow you to make quick changes, or to debug a problem.</p>
|
|
|
|
<blockquote>
|
|
<p><strong>Note</strong>: Your exec&rsquo;ed <code>sh</code> process will not have the same environment settings
|
|
as the main container process and its children.</p>
|
|
</blockquote>
|
|
|
|
<h3 id="managing-volumes">Managing Volumes</h3>
|
|
|
|
<p>You can choose to make all of a container&rsquo;s volumes mapped to directories on
|
|
on your Mac by clicking on the folders in the &ldquo;Edit Files&rdquo; section of the
|
|
container summary screen.</p>
|
|
|
|
<p>This allows you to manage files in volumes via the Finder.
|
|
Kitematic exposes a container&rsquo;s volume data under <code>~/Documents/Kitematic/&lt;container's name&gt;/</code>.
|
|
Quick access to this folder (or directory) is available via the app:</p>
|
|
|
|
<p><img src="../kitematic/images/volumes-dir.png" alt="Accessing the volumes directory" /></p>
|
|
|
|
<blockquote>
|
|
<p><strong>Note</strong>: When you &ldquo;Enable all volumes to edit files in Finder&rdquo;, the Docker
|
|
container will be stopped, removed and re-created with the new <code>volumes</code>
|
|
flag.</p>
|
|
</blockquote>
|
|
|
|
<h4 id="changing-volume-directories">Changing Volume Directories</h4>
|
|
|
|
<p>Let&rsquo;s say you have an Nginx webserver running via Kitematic (using the
|
|
<code>kitematic/hello-world-nginx</code> image on DockerHub). However, you don&rsquo;t want to
|
|
use the default directory created for the website_files volume. Instead, you
|
|
already have the HTML, Javascript, and CSS for your website under
|
|
<code>~/workspace/website</code>.</p>
|
|
|
|
<p>Navigate to the &ldquo;Settings&rdquo; tab of the container, and go to the &ldquo;Volumes&rdquo;. This
|
|
screen allows you to set the mappings individually.</p>
|
|
|
|
<p><img src="../kitematic/images/change-folder.png" alt="screen shot 2015-02-28 at 2 48 01 pm" /></p>
|
|
|
|
<blockquote>
|
|
<p><strong>Note</strong>: When you &ldquo;Change Folders&rdquo;, the Docker
|
|
container will be stopped, removed and re-created with the new <code>volumes</code>
|
|
flag.</p>
|
|
</blockquote>
|
|
|
|
<h3 id="setting-the-container-name">Setting the container name</h3>
|
|
|
|
<p>By default, Kitematic sets the container name to the same as the image name (or
|
|
with a <code>-&lt;number&gt;</code> if there are more than one.
|
|
To simplify administration, or when using container linking or volumes, you may
|
|
want to rename it.</p>
|
|
|
|
<blockquote>
|
|
<p><strong>Note</strong>: When you rename the container it will be stopped, removed and
|
|
re-created with the new name (due to the default volumes mapping).</p>
|
|
</blockquote>
|
|
|
|
<h3 id="adding-environment-variables">Adding Environment variables</h3>
|
|
|
|
<p>Many images use environment variables to let you customise them. The &ldquo;General&rdquo;
|
|
&ldquo;Settings&rdquo; tab allows you to add and modify the environment variables used to
|
|
start a container.</p>
|
|
|
|
<p>The list of environment variables will show any that have been set on the image
|
|
metadata - for example, using the <code>ENV</code> instruction in the Dockerfile.</p>
|
|
|
|
<p><TODO: image of the jenkins container></p>
|
|
|
|
<p>When you &ldquo;Save&rdquo; the changed environment variables, the container will be stopped,
|
|
removed and re-created.</p>
|
|
|
|
<h3 id="delete-container">Delete container</h3>
|
|
|
|
<p>On the &ldquo;General&rdquo; &ldquo;Settings&rdquo; tab, you can delete the container. Clicking &ldquo;Delete
|
|
Container&rdquo; will also stop the container if necessary.</p>
|
|
|
|
<p>You can also delete a container by clicking the <code>X</code> icon in the container list.</p>
|
|
|
|
<p>Kitematic will prompt you to confirm that you want to delete.</p>
|
|
|
|
<h4 id="list-the-exposed-ports-and-how-to-access-them">List the exposed Ports and how to access them</h4>
|
|
|
|
<p>To see the complete list of exposed ports, go to &ldquo;Settings&rdquo; then &ldquo;Ports&rdquo;. This
|
|
page lists all the container ports exposed, and the IP address and host-only
|
|
network port that you can access use to access that container from your OS X
|
|
system.</p>
|
|
|
|
<h2 id="docker-command-line-access">Docker Command-line Access</h2>
|
|
|
|
<p>You can interact with existing containers in Kitematic or create new containers
|
|
via the Docker Command Line Interface (CLI). Any changes you make on the CLI are
|
|
directly reflected in Kitematic.</p>
|
|
|
|
<p>To open a terminal via Kitematic, just press the whale button at the bottom left, as
|
|
shown below:</p>
|
|
|
|
<p><img src="../kitematic/images/cli-access-button.png" alt="CLI access button" /></p>
|
|
|
|
<h3 id="example-creating-a-new-redis-container">Example: Creating a new Redis container</h3>
|
|
|
|
<p>Start by opening a Docker-CLI ready terminal by clicking the whale button as
|
|
described above. Once the terminal opens, enter <code>docker run -d -P redis</code>. This
|
|
will pull and run a new Redis container via the Docker CLI.</p>
|
|
|
|
<p><img src="../kitematic/images/cli-terminal.png" alt="Docker CLI terminal window" /></p>
|
|
|
|
<blockquote>
|
|
<p><strong>Note</strong>: If you&rsquo;re creating containers from the command line, use <code>docker run -d</code>
|
|
so that Kitematic can re-create the container when settings are changed via the
|
|
Kitematic user interface. Containers started without <code>-d</code> will fail to re-start.</p>
|
|
</blockquote>
|
|
|
|
<p>Now, go back to Kitematic. The Redis container should now be visible.</p>
|
|
|
|
<p><img src="../kitematic/images/cli-redis-container.png" alt="Redis container in Kitematic" /></p>
|
|
|
|
<h2 id="next-steps">Next Steps</h2>
|
|
|
|
<p>For an example using Kitematic to run a Minecraft server, take a look at
|
|
the <a href="../kitematic/minecraft-server/">Minecraft server</a> page.</p>
|
|
</description>
|
|
</item>
|
|
|
|
<item>
|
|
<title>Known Issues</title>
|
|
<link>http://localhost/kitematic/known-issues/</link>
|
|
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
|
|
|
<guid>http://localhost/kitematic/known-issues/</guid>
|
|
<description>
|
|
|
|
<h1 id="kitematic-known-issues">Kitematic: Known Issues</h1>
|
|
|
|
<p>Kitematic is in beta, so we&rsquo;re still working out the kinks. The most common
|
|
errors occur at the setup stage since creating a VM reliably with VirtualBox can
|
|
be tricky. We are working on this problem.</p>
|
|
|
|
<p>In the meantime, below are a list of common errors and solutions that work for
|
|
most people.</p>
|
|
|
|
<h2 id="setup-error-or-hanging-at-99">Setup Error or Hanging at 99%</h2>
|
|
|
|
<p>Sometimes Kitematic doesn&rsquo;t set up VirtualBox properly. Retrying the setup
|
|
usually works (via one of the two retry buttons). If not, try the following
|
|
commands on the command line:</p>
|
|
|
|
<ul>
|
|
<li><code>docker-machine rm -f dev</code></li>
|
|
<li><code>docker-machine create -d virtualbox dev</code></li>
|
|
</ul>
|
|
|
|
<p>Then re-open Kitematic. This usually fixes the issue, but if it persists, feel
|
|
free to view our <a href="https://github.com/kitematic/kitematic/issues?q=is%3Aopen+is%3Aissue+label%3Abug">existing GitHub
|
|
issues</a>.</p>
|
|
|
|
<h2 id="contributing-fixes">Contributing Fixes</h2>
|
|
|
|
<p>We&rsquo;re always looking for help to make Kitematic better and more reliable! Visit
|
|
<a href="https://github.com/kitematic/kitematic">our GitHub page</a> for docs on how to
|
|
contribute.</p>
|
|
|
|
<p>Under the hood, Kitematic uses <a href="https://github.com/docker/machine">Docker
|
|
Machine</a> to provision Docker-enabled VMs via
|
|
VirtualBox. We&rsquo;re still working on a stronger integration with this project.
|
|
Their <a href="https://github.com/docker/machine">GitHub repo</a> is a great place to start
|
|
if you&rsquo;re looking to help fix specific issues around VM provisioning.</p>
|
|
|
|
<h2 id="view-all-issues">View All Issues</h2>
|
|
|
|
<p>For a full list of Kitematic bugs or issues see our <a href="https://github.com/kitematic/kitematic/issues?q=is%3Aopen+is%3Aissue+label%3Abug">existing GitHub
|
|
issues</a> labelled as <code>bug</code>.</p>
|
|
</description>
|
|
</item>
|
|
|
|
<item>
|
|
<title>Set up a Minecraft Server</title>
|
|
<link>http://localhost/kitematic/minecraft-server/</link>
|
|
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
|
|
|
<guid>http://localhost/kitematic/minecraft-server/</guid>
|
|
<description>
|
|
|
|
<h1 id="kitematic-tutorial-set-up-a-minecraft-server">Kitematic tutorial: Set up a Minecraft server</h1>
|
|
|
|
<p>This is a quick tutorial demonstrating how to set up a local Minecraft server
|
|
using Kitematic and Docker.</p>
|
|
|
|
<h3 id="create-minecraft-server-container">Create Minecraft Server Container</h3>
|
|
|
|
<p>First, if you haven&rsquo;t yet done so, <a href="../">download and start
|
|
Kitematic</a>. Once installed and running, the app should look like this:</p>
|
|
|
|
<p>Create a container from the recommended Minecraft image by clicking the &ldquo;Create&rdquo;
|
|
button.</p>
|
|
|
|
<p><img src="../kitematic/images/minecraft-create.png" alt="create Minecraft container" /></p>
|
|
|
|
<p>After the image finishes downloading, you&rsquo;ll see the home screen for the
|
|
Minecraft container. Your Minecraft server is now up and running inside a Docker
|
|
container. Note that we&rsquo;ve marked the IP and port you can use to connect to
|
|
your Minecraft server in red (your IP and port may be different from what&rsquo;s
|
|
shown).</p>
|
|
|
|
<p><img src="../kitematic/images/minecraft-port.png" alt="Minecraft server port and IP info" /></p>
|
|
|
|
<h3 id="connect-to-minecraft-server">Connect to Minecraft server</h3>
|
|
|
|
<p>Open your Minecraft client, log in with your Minecraft account and click on the
|
|
&ldquo;Multiplayer&rdquo; button.</p>
|
|
|
|
<p><img src="../kitematic/images/minecraft-login.png" alt="Minecraft login screen" /></p>
|
|
|
|
<p>Click the &ldquo;Add Server&rdquo; button to add the Minecraft server you want to connect
|
|
to.</p>
|
|
|
|
<p><img src="../kitematic/images/minecraft-login.png" alt="Add server" /></p>
|
|
|
|
<p>Fill in the &ldquo;Server Address&rdquo; text box with the marked IP and port from Kitematic
|
|
you saw earlier.</p>
|
|
|
|
<p><img src="../kitematic/images/minecraft-server-address.png" alt="Minecraft server address" /></p>
|
|
|
|
<p>Click on the play button to connect to your Minecraft server and enjoy!</p>
|
|
|
|
<h3 id="change-map-using-docker-volume">Change map using Docker volume</h3>
|
|
|
|
<p>Open the &ldquo;data&rdquo; folder from Kitematic (You&rsquo;ll need to &ldquo;Enable all volumes to edit
|
|
files via Finder&rdquo;). We use Docker Volume to map the folder from the Minecraft
|
|
Docker container onto your computer.</p>
|
|
|
|
<p><img src="../kitematic/images/minecraft-data-volume.png" alt="Minecraft data volume" /></p>
|
|
|
|
<p>The Finder will open, allowing you to replace your current map with the new one
|
|
you desire.</p>
|
|
|
|
<p><img src="../kitematic/images/minecraft-map.png" alt="Minecraft maps" /></p>
|
|
|
|
<p>Restart your container by clicking the &ldquo;Restart&rdquo; button.</p>
|
|
|
|
<p><img src="../kitematic/images/minecraft-restart.png" alt="Restart Minecraft container" /></p>
|
|
|
|
<p>Go back to your Minecraft client and join your server. The new map should load.</p>
|
|
|
|
<h2 id="next-steps">Next Steps</h2>
|
|
|
|
<p>For an example using Kitematic to run Nginx, take a look at the <a href="../kitematic/nginx-web-server/">Nginx web
|
|
server</a> page.</p>
|
|
</description>
|
|
</item>
|
|
|
|
<item>
|
|
<title>Set up an Nginx web server</title>
|
|
<link>http://localhost/kitematic/nginx-web-server/</link>
|
|
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
|
|
|
<guid>http://localhost/kitematic/nginx-web-server/</guid>
|
|
<description>
|
|
|
|
<h1 id="kitematic-tutorial-serving-a-static-website-with-nginx">Kitematic Tutorial: Serving a Static Website with Nginx</h1>
|
|
|
|
<p>In this tutorial, you will:</p>
|
|
|
|
<ul>
|
|
<li>Download and run a web server container</li>
|
|
<li>Explore the container&rsquo;s website data natively on your Mac</li>
|
|
<li>Use volumes to modify the website data</li>
|
|
</ul>
|
|
|
|
<p>In this example website we&rsquo;ll be serving the popular 2048 game, as shown below.
|
|
Let&rsquo;s get to it!</p>
|
|
|
|
<p><img src="../kitematic/images/nginx-2048.png" alt="2048 game" /></p>
|
|
|
|
<h4 id="running-the-nginx-web-server-container">Running the Nginx Web Server Container</h4>
|
|
|
|
<p>First, if you haven&rsquo;t yet done so, <a href="../">download and start
|
|
Kitematic</a>. Once installed and running, the app should look like this:</p>
|
|
|
|
<p><img src="../kitematic/images/nginx-create.png" alt="Nginx create" /></p>
|
|
|
|
<p>Click on the <em>Create</em> button of the <code>hello-world-nginx</code> listing as shown above.
|
|
Kitematic will download (also known as pull the image) and then run a tiny Nginx web server
|
|
in a Docker container, allowing it to serve website data to your Mac.</p>
|
|
|
|
<p><img src="../kitematic/images/nginx-hello-world.png" alt="download Nginx hello world" /></p>
|
|
|
|
<p>Once it&rsquo;s done downloading you should see a quick preview of the example website
|
|
that comes with the container, as shown below. Click on the preview to see the
|
|
result in your own browser.</p>
|
|
|
|
<p><img src="../kitematic/images/nginx-preview.png" alt="Nginx preview" /></p>
|
|
|
|
<p><strong>What just happened?</strong> Kitematic downloaded the <code>kitematic/hello-world-nginx</code>
|
|
image from the Docker Hub and then created and ran a Docker Nginx container from
|
|
this image.</p>
|
|
|
|
<h4 id="viewing-the-website-data-in-finder">Viewing the Website Data in Finder</h4>
|
|
|
|
<p>This container exposes website data via a <em>Docker volume</em>. Kitematic makes
|
|
managing Docker volumes easy - you can edit the data in Finder or with your
|
|
favorite text editor. By default, Kitematic places volumes under <code>~/Kitematic</code>
|
|
but you can change this in the container settings. To access the files via
|
|
finder, click on the in-app folder icon for a container and &ldquo;Enable all volumes
|
|
to edit via Finder&rdquo;:</p>
|
|
|
|
<p><img src="../kitematic/images/nginx-data-volume.png" alt="Nginx data volume" /></p>
|
|
|
|
<p>A Finder window of the folder should open containing the index.html file we see
|
|
being served by the container.</p>
|
|
|
|
<p><img src="../kitematic/images/nginx-data-folder.png" alt="Nginx data folder" /></p>
|
|
|
|
<h4 id="serving-your-own-website-data">Serving Your Own Website Data</h4>
|
|
|
|
<p>Now let&rsquo;s try serving a more interesting website. <a href="https://github.com/gabrielecirulli/2048/archive/master.zip">Download the zipped
|
|
files</a> for 2048, a
|
|
popular (and addictive) web-based tile game. Extract this zip file into the
|
|
folder you just opened:</p>
|
|
|
|
<p><img src="../kitematic/images/nginx-2048-files.png" alt="Website files for 2048" /></p>
|
|
|
|
<p>Switch back to Kitematic and restart the container by clicking the &ldquo;Restart&rdquo;
|
|
button as shown below. Your Nginx container should now be serving 2048.</p>
|
|
|
|
<p><img src="../kitematic/images/nginx-serving-2048.png" alt="Nginx running 2048" /></p>
|
|
|
|
<p><strong>What just happened?</strong></p>
|
|
|
|
<p>Kitematic can map Docker container volumes to directories on your
|
|
Mac. In this case you changed the container&rsquo;s volume data via the Finder to
|
|
serve a website we downloaded.</p>
|
|
|
|
<h2 id="next-steps">Next Steps</h2>
|
|
|
|
<p>For an example using Kitematic to run a Local RethinkDB database, take a look at
|
|
the <a href="../kitematic/rethinkdb-dev-database/">RethinkDB development Database</a> example.</p>
|
|
</description>
|
|
</item>
|
|
|
|
</channel>
|
|
</rss> |