Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added more detailed documentation for using Docker [#971]
- Loading branch information
Showing
1 changed file
with
43 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,49 @@ | ||
# Running ComiXed in a Docker Container | ||
## by pidockmedia | ||
#### Concept by jakanapes | ||
# Running ComiXed In A Docker Container | ||
|
||
## To run this image from the repository simply do: | ||
## Installing The Docker Image | ||
|
||
```docker run -it -p 7171:7171/tcp -v /PATH/TO/COMICS:/comic_dir -v /PATH/TO/COMIXDB:/root/.comixed comixed/comixed:latest``` | ||
Installation is simple: | ||
|
||
The latest version may be a development build. Use this to get the latest release: | ||
``` $ docker pull comixed/comixed:latest``` | ||
|
||
```docker run -it -p 7171:7171/tcp -v /PATH/TO/COMICS:/comic_dir -v /PATH/TO/COMIXDB:/root/.comixed comixed/comixed:release``` | ||
This pulls the latest version. Or you can replace **latest** with a specific version if you wish. | ||
|
||
You could also pull a specific version: | ||
## Initial Run | ||
### Where To Place Your Comics | ||
|
||
```docker run -it -p 7171:7171/tcp -v /PATH/TO/COMICS:/comic_dir -v /PATH/TO/COMIXDB:/root/.comixed comixed/comixed:0.11.0-SNAPSHOT``` | ||
It's recommended that you select a subdirectory that's decided solely to your library. This directory will hold both | ||
the comic files as well as the database files (assuming you use the embedded database). It will also be the location | ||
where you will place new comics in order to import them into your library. | ||
|
||
For this document, we will assume that directory is **/Users/reader/comics**. | ||
|
||
Beneath this directory, we want to have the actual comic files organized under a directory named **library** and the | ||
database files under a directory named **database**. | ||
|
||
### Starting The Docker Image For The First Time | ||
|
||
To create the Docker image using the above directories, we'll use the following command line: | ||
|
||
``` $ docker create --name comixed -it -p 7171:7171/tcp -v /Users/reader/comixed/library:/comic_dir -v /Users/reader/comixed/database:/root/.comixed comixed/comixed:latest``` | ||
|
||
This command line: | ||
1. creates a runnable container named "comixed" in Docker, | ||
2. redirects port 7171 from the host to the container, | ||
3. uses /Users/reader/comixed/library when it looks for comics, and | ||
4. uses /Users/reader/comixed/database for storing the database. | ||
|
||
Then to start it running, use: | ||
|
||
``` $ docker start comixed``` | ||
|
||
## Importing Comics With Docker | ||
|
||
To import new comics using your Docker image, you need to create a directory below your library. Since, in our example | ||
above, we put our comics in /Users/reader/comixed/library, we'll create a new directory below that called | ||
**/Users/reader/comixed/library/importing**. | ||
|
||
We then copy the new comics into this directory. | ||
|
||
Then, from the **Image Comics** page, you enter as the import directory **/comic_dir/importing** and click the search | ||
button. This will return all of the comics you just copied into that directory, and allow you to import them into your | ||
library. |