Remove Kitematic docs, as it's deprecated

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Sebastiaan van Stijn 2021-08-09 12:48:20 +02:00
parent 31ef27a552
commit e782f74758
No known key found for this signature in database
GPG Key ID: 76698F39D527CE8C
40 changed files with 20 additions and 540 deletions

View File

@ -9,7 +9,6 @@
texts:
experimental: "The functionality described on this page is marked as Experimental, and as such, may change before it becomes generally available."
kitematic: "**Legacy desktop solution.** Kitematic is a legacy solution, bundled with [Docker Toolbox](/toolbox/overview/). We recommend updating to [Docker Desktop for Mac](/docker-for-mac/) or [Docker Desktop for Windows](/docker-for-windows/) if your system meets the requirements for one of those applications."
# URL based advisories

View File

@ -1562,17 +1562,5 @@ manuals:
title: Migrate from Boot2Docker to Machine
- path: /toolbox/
title: Docker Toolbox (deprecated)
- sectiontitle: Kitematic
section:
- path: /kitematic/userguide/
title: "Kitematic user guide: intro &amp; overview"
- path: /kitematic/nginx-web-server/
title: Set up an Nginx web server
- path: /kitematic/minecraft-server/
title: Set up a Minecraft Server
- path: /kitematic/rethinkdb-dev-database/
title: Creating a local RethinkDB database for development
- path: /kitematic/faq/
title: Frequently asked questions
- path: /kitematic/known-issues/
title: Known issues
- path: /kitematic/
title: Kitematic (deprecated)

View File

@ -1,6 +1,6 @@
---
description: Docker Dashboard
keywords: Docker Dashboard, manage, containers, images
keywords: Docker Dashboard, manage, containers, gui, dashboard, images, kitematic
title: Docker Dashboard
redirect_from:
- /docker-for-mac/dashboard/

View File

@ -1,63 +0,0 @@
---
advisory: kitematic
description: Documentation covering common questions users have about Kitematic
keywords: docker, documentation, about, technology, kitematic, gui
title: 'Kitematic: Frequently asked questions (FAQ)'
---
### Is Kitematic open source?
Yes! Our source code is available on
[GitHub](https://github.com/kitematic/kitematic). Kitematic is open source
software released under the Apache 2.0 license.
### How can I contribute to Kitematic?
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>.
### How does Kitematic work with Docker?
Kitematic connects directly to a running instance of Docker and controls it via
the Docker Engine API.
### Which platforms does Kitematic support?
Right now Kitematic works on macOS and Windows. Linux is planned in the
future. Review our product <a
href="https://github.com/kitematic/kitematic/blob/master/ROADMAP.md">roadmap</a>.
### Why does Kitematic collect usage analytics and bug reports?
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.
You can opt-out of this anytime via the in-app preferences.
#### What we DON'T collect
- Personal information: any information that would allow us to determine a
specific user of Kitematic
- Information or data relating to code, containers, or Docker images opened via
Kitematic.
#### What we DO collect
- Anonymous events for actions in the app. We never collect data associated with
events. For example:
- User searched for images (but not what the search query was).
- User created a container (but not which image, the name of the container or
any data involved)
- User opened the preferences pane
- User deleted a container
- Errors names, messages & stack traces (scrubbed for user names)
- Operating System, Kitematic and installed VirtualBox versions
We'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.
## Next steps
For information about known issues in the current release of Kitematic, take a
look at the [Known issues](./known-issues.md).

Binary file not shown.

Before

Width:  |  Height:  |  Size: 286 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 114 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 393 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 316 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 64 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 59 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 330 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 95 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 33 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 51 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 330 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 502 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 261 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 145 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 502 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 502 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 486 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 73 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 64 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 286 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 73 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 95 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 308 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 558 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 360 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 330 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 163 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 254 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 295 KiB

View File

@ -1,10 +1,21 @@
---
advisory: kitematic
description: Documentation that provides an overview of Kitematic and installation instructions
keywords: docker, documentation, about, technology, kitematic, gui
title: Kitematic
description: Kitematic userguide (deprecated)
keywords: kitematic, deprecated
title: Kitematic (deprecated)
redirect_from:
- /kitematic/faq/
- /kitematic/known-issues/
- /kitematic/minecraft-server/
- /kitematic/nginx-web-server/
- /kitematic/rethinkdb-dev-database/
- /kitematic/userguide/
notoc: true
---
Kitematic, the Docker GUI, runs on Mac and Windows operating systems.
> **Deprecated**
>
> Kitematic has been deprecated. Please use the Dashboard included with Docker
> Desktop instead. See [Docker Desktop](../desktop/dashboard.md).
{: .warning }
For information about using Kitematic, take a look at the [User Guide](userguide.md).
The source code for Kitematic has been archived, but [can be found on GitHub](https://github.com/docker/kitematic){:target="_blank" rel="noopener" class="_"}.

View File

@ -1,41 +0,0 @@
---
advisory: kitematic
description: Information about known issues in Kitematic
keywords: docker, documentation, about, technology, kitematic, gui
title: 'Kitematic: Known issues'
---
The most common errors with Kitematic occur at the setup stage since creating a
VM reliably with VirtualBox can be tricky. We are working on this problem.
Below are a list of common errors and solutions that work for most people.
## Setup error or hanging at 99%
Sometimes Kitematic doesn'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:
- `docker-machine rm -f dev`
- `docker-machine create -d virtualbox dev`
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>.
## Contribute fixes
We're always looking for help to make Kitematic better and more reliable! Visit
[our GitHub page](https://github.com/kitematic/kitematic) for docs on how to
contribute.
Under the hood, Kitematic uses [Docker
Machine](https://github.com/docker/machine) to provision Docker-enabled VMs via
VirtualBox. We're still working on a stronger integration with this project.
Their [GitHub repo](https://github.com/docker/machine) is a great place to start
if you're looking to help fix specific issues around VM provisioning.
## View all issues
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> labeled as `bug`.

View File

@ -1,72 +0,0 @@
---
advisory: kitematic
description: Tutorial demonstrating the setup of a Minecraft server using Docker and Kitematic
keywords: docker, documentation, about, technology, kitematic, gui, minecraft, tutorial
title: 'Kitematic tutorial: Set up a Minecraft server'
---
This is a quick tutorial demonstrating how to set up a local Minecraft server
using Kitematic and Docker.
### Create Minecraft server container
First, if you haven't yet done so, [download and start Kitematic](index.md).
Once installed and running, the app should look like this:
Create a container from the recommended Minecraft image by clicking the "Create"
button.
![create Minecraft container](images/minecraft-create.png)
After the image finishes downloading, you see the home screen for the
Minecraft container. Your Minecraft server is now up and running inside a Docker
container. We'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's
shown).
![Minecraft server port and IP info](images/minecraft-port.png)
### Connect to Minecraft server
Open your Minecraft client, log in with your Minecraft account and click on the
"Multiplayer" button.
![Minecraft login screen](images/minecraft-login.png)
Click the "Add Server" button to add the Minecraft server you want to connect
to.
![Add server](images/minecraft-add-server.png)
Fill in the "Server Address" text box with the marked IP and port from Kitematic
you saw earlier.
![Minecraft server address](images/minecraft-server-address.png)
Click on the play button to connect to your Minecraft server and enjoy!
### Change map using Docker volume
Open the "data" folder from Kitematic (Select "Enable all volumes to edit
files via Finder"). We use Docker Volume to map the folder from the Minecraft
Docker container onto your computer.
![Minecraft data volume](images/minecraft-data-volume.png)
The Finder opens, allowing you to replace your current map with the new one
you desire.
![Minecraft maps](images/minecraft-map.png)
Restart your container by clicking the "Restart" button.
![Restart Minecraft container](images/minecraft-restart.png)
Go back to your Minecraft client and join your server. The new map should load.
## Next steps
For an example using Kitematic to run Nginx, take a look at the
[Nginx web server](./nginx-web-server.md) page.

View File

@ -1,80 +0,0 @@
---
advisory: kitematic
description: Tutorial demonstrating the setup of an Nginx web server using Docker and Kitematic
keywords: docker, documentation, about, technology, kitematic, gui, nginx, tutorial
title: 'Kitematic tutorial: Serve a static website with NGINX'
---
This tutorial guides you through these steps:
- Download and run a web server container
- Explore the container's website data natively on your Mac
- Use volumes to modify the website data
This example website serves the popular 2048 game. Let's get to it!
![2048 game](images/nginx-2048.png)
#### Run the Nginx web server container
First, if you haven't yet done so, [download and start Kitematic](index.md).
Once installed and running, the app should look like this:
![Nginx create](images/nginx-create.png)
Click on the _Create_ button of the `hello-world-nginx` listing as shown above.
Kitematic pulls and runs a tiny Nginx web server in a Docker container, allowing
it to serve website data to your Mac.
![download Nginx hello world](images/nginx-hello-world.png)
Once it'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.
![Nginx preview](images/nginx-preview.png)
**What just happened?** Kitematic downloaded the `kitematic/hello-world-nginx`
image from the Docker Hub and then created and ran a Docker Nginx container from
this image.
#### View the website data in Finder
This container exposes website data via a _Docker volume_. 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 `~/Kitematic`
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 "Enable all volumes
to edit via Finder":
![Nginx data volume](images/nginx-data-volume.png)
A Finder window of the folder should open containing the index.html file we see
being served by the container.
![Nginx data folder](images/nginx-data-folder.png)
#### Serve your own website data
Now let's try serving a more interesting website. [Download the zipped
files](https://github.com/gabrielecirulli/2048/archive/master.zip) for 2048, a
popular (and addictive) web-based tile game. Extract this zip file into the
folder you just opened:
![Website files for 2048](images/nginx-2048-files.png)
Switch back to Kitematic and restart the container by clicking the "Restart"
button as shown below. Your Nginx container should now be serving 2048.
![Nginx running 2048](images/nginx-serving-2048.png)
**What just happened?**
Kitematic can map Docker container volumes to directories on your
Mac. In this case you changed the container's volume data via the Finder to
serve a website we downloaded.
## Next steps
For an example using Kitematic to run a Local RethinkDB database, take a look at
the [RethinkDB development Database](./rethinkdb-dev-database.md) example.

View File

@ -1,60 +0,0 @@
---
advisory: kitematic
description: Tutorial demonstrating the setup of an RethinkDB database for development
keywords: docker, documentation, about, technology, kitematic, gui, rethink, tutorial
title: 'Kitematic tutorial: Create a local RethinkDB database for development'
---
This tutorial guides you through these steps:
- Create a RethinkDB Container for Development
- (Advanced) Clone a small Node.js application and write data into RethinkDB.
### Set up RethinkDB in Kitematic
First, if you haven't yet done so, [download and start Kitematic](index.md).
Once open, the app should look like this:
![Rethink create button](images/rethink-create.png)
Click on the _Create_ button of the `rethinkdb` image listing in the recommended
list as shown above. This downloads and runs a RethinkDB container within a few
minutes. Once it's done, a local RethinkDB database is up and running.
![Rethink container](images/rethink-container.png)
Let's start using it to develop a node.js app. For now, let's figure out which
IP address and port RethinkDB is listening on. To find out, click the `Settings`
tab and then the `Ports` section:
![Rethink create button](images/rethink-ports.png)
You can see there that for RethinkDB port `28015`, the container is listening on
host `localhost` and port `32783` (in this example - ports may be different
for you). This means you can now reach RethinkDB via a client driver at
`127.0.0.1:32783`. Again, this IP address may be different for you.
### (Advanced) Save Data into RethinkDB with a local Node.js App
Now, create the RethinkDB example chat application running on your local
macOS system to test drive your new containerized database.
First, if you don't have it yet, [download and install
Node.js](https://nodejs.org/en/).
> **Note**: This example needs Xcode installed.
In your terminal, type:
$ export RDB_HOST=127.0.0.1 # replace with IP from above step
$ export RDB_PORT=32783 # 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
Now, point your browser to `http://localhost:8000`. Congratulations, you've
successfully used a RethinkDB container in Kitematic to build a real-time chat
app. Happy coding!
![Rethink app preview](images/rethinkdb-preview.png)

View File

@ -1,202 +0,0 @@
---
advisory: kitematic
description: Documentation that provides an overview of Kitematic and installation instructions
keywords: docker, documentation, about, technology, kitematic, gui
title: Kitematic user guide
---
## Overview
Kitematic is an open source project built to simplify and streamline using
Docker on a Mac or Windows PC. Kitematic automates the Docker
installation and setup process and provides an intuitive graphical user
interface (GUI) for running Docker containers. Kitematic integrates with
[Docker Machine](/machine/) to provision a VirtualBox VM
and install the Docker Engine locally on your machine.
Once installed, the Kitematic GUI launches and from the home screen you are
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.
First, if you haven't yet done so, download and install Kitematic in one of the following ways:
* Choose **Kitematic** from the Docker Desktop for Mac or Docker Desktop for Windows menu to get started with the Kitematic install.
* Download Kitematic directly from the [Kitematic releases page](https://github.com/docker/kitematic/releases/).
Start Kitematic. (On desktop systems, click on the app.)
## Log in with your Docker ID
Provide your Docker ID and user name and click **LOG IN** or click **Skip for now** to browse Docker Hub as a guest.
## Container list
Kitematic lists all running and stopped containers on the left side, underneath
the "New Container" link.
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.
You can click on any container to view its logs (the output of the main container
process), restart, stop or exec `sh` in that container. See
[Working with a container](userguide.md#working-with-a-container) for more details.
## Creating a new container
The "New Container" page lets you search for and select from images on the Docker Hub.
When you've found the image you want to run, you can click "Create" to pull, create,
and run the container.
![Nginx create](images/browse-images.png)
## Working with a container
If you select a non-running container, either stopped, or paused, you can
"Restart" or "Stop" the container using the icons. You can also view the entire
main container process' output logs, and in the Settings section you can make
changes which are used if you "Restart" this container.
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' logs, and any container volumes that have been
configured.
![Redis container in Kitematic](images/cli-redis-container.png)
The summary page shows different things depending on the image metadata. If
a known "web" port (see below) is `EXPOSED`, then Kitematic assumes its a web page,
and shows a preview of the site at `/`. If other ports are exposed, then it
shows a list of those ports, and the Docker daemon IP and port they are mapped
to. If there are any `VOLUMES`, then these are shown. At minimum, the summary
screen shows the main container process' log output.
The currently detected "web" ports are, `80`, `8000`, `8080`, `3000`, `5000`,
`2368`, `9200`, and `8983`.
### Viewing container logs
You can view the entire main container process' log output either by clicking on the "Logs"
preview image, or by clicking on the "Logs" tab.
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 is restarted,
so this resets this log view.
### Starting a terminal in a container
The "Terminal" icon at the top of the container summary runs `docker container exec -i -t <your container> sh`.
This allows you to make quick changes, or to debug a problem.
> **Note**: Your exec'ed `sh` process does not have the same environment settings
> as the main container process and its children.
> Get the environment commands for your shell: `docker-machine env default`.
### Managing Volumes
You can choose to make all of a container's volumes mapped to directories on
on your Mac by clicking on the folders in the "Edit Files" section of the
container summary screen.
This allows you to manage files in volumes via the Finder.
Kitematic exposes a container's volume data under `~/Documents/Kitematic/<container's name>/`.
Quick access to this folder (or directory) is available via the app:
![Accessing the volumes directory](images/volumes-dir.png)
> **Note**: When you "Enable all volumes to edit files in Finder", the Docker
> container is stopped, removed and re-created with the new `volumes`
> flag.
#### Changing Volume Directories
Let's say you have an Nginx webserver running via Kitematic (using the
`kitematic/hello-world-nginx` image on DockerHub). However, you don'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
`~/workspace/website`.
Navigate to the "Settings" tab of the container, and go to the "Volumes". This
screen allows you to set the mappings individually.
![screen shot 2015-02-28 at 2 48 01 pm](images/change-folder.png)
> **Note**: When you "Change Folders", the Docker
> container is stopped, removed and re-created with the new `volumes`
> flag.
### Setting the container name
By default, Kitematic sets the container name to the same as the image name (or
with a `-<number>` if there are more than one.
To simplify administration, or when using container linking or volumes, you may
want to rename it.
> **Note**: When you rename the container it is stopped, removed and
> re-created with the new name (due to the default volumes mapping).
### Adding Environment variables
Many images use environment variables to let you customize them. The "General"
"Settings" tab allows you to add and modify the environment variables used to
start a container.
The list of environment variables shows any that have been set on the image
metadata - for example, using the `ENV` instruction in the Dockerfile.
When you "Save" the changed environment variables, the container is
stopped, removed and re-created.
### Delete container
On the "General" "Settings" tab, you can delete the container. Clicking "Delete
Container" also stops the container if necessary.
You can also delete a container by clicking the `X` icon in the container list.
Kitematic prompts you to confirm that you want to delete.
#### List the exposed Ports and how to access them
To see the complete list of exposed ports, go to "Settings" then "Ports". 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 macOS
system.
## Docker Command-line Access
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.
To open a terminal via Kitematic, just press the whale button at the bottom left, as
shown below:
![CLI access button](images/cli-access-button.png)
### Example: Creating a new Redis container
Start by opening a Docker-CLI ready terminal by clicking the whale button as
described above. Once the terminal opens, enter `docker run -d -P redis`. This
pulls, creates, and runs a new Redis container via the Docker CLI.
![Docker CLI terminal window](images/cli-terminal.png)
> **Note**: If you're creating containers from the command line, use `docker run -d`
> so that Kitematic can re-create the container when settings are changed via the
> Kitematic user interface. Containers started without `-d` fails to restart.
Now, go back to Kitematic. The Redis container is now visible.
![Redis container in Kitematic](images/cli-redis-container.png)
## Next Steps
For an example using Kitematic to run a Minecraft server, take a look at
the [Minecraft server](./minecraft-server.md) page.