|
@@ -0,0 +1,65 @@
|
|
|
|
|
+**Compact Box Docker Image README**
|
|
|
|
|
+=====================================
|
|
|
|
|
+
|
|
|
|
|
+**Overview**
|
|
|
|
|
+------------
|
|
|
|
|
+
|
|
|
|
|
+The Compact Box Docker image is designed to simplify file operations and examination of volume contents. This image is built on top of the official Alpine Linux image and includes a set of essential tools for file management.
|
|
|
|
|
+
|
|
|
|
|
+**Usage**
|
|
|
|
|
+---------
|
|
|
|
|
+
|
|
|
|
|
+To use the Compact Box Docker image, follow these steps:
|
|
|
|
|
+
|
|
|
|
|
+### 1. Pull the Image
|
|
|
|
|
+
|
|
|
|
|
+First, pull the Compact Box Docker image from the registry:
|
|
|
|
|
+```bash
|
|
|
|
|
+docker pull compact-box
|
|
|
|
|
+```
|
|
|
|
|
+### 2. Run the Container
|
|
|
|
|
+
|
|
|
|
|
+Run a new container from the image, mounting a volume at `/mnt`:
|
|
|
|
|
+```bash
|
|
|
|
|
+docker run -it --rm --name compact -v nc4_files:/mnt compact-box
|
|
|
|
|
+```
|
|
|
|
|
+Replace `nc4_files` with the name of your volume.
|
|
|
|
|
+
|
|
|
|
|
+### 3. Access the Container
|
|
|
|
|
+
|
|
|
|
|
+You will be logged into the container as the root user. You can now perform file operations and examine the contents of the volume at `/mnt`.
|
|
|
|
|
+
|
|
|
|
|
+**Tools Included**
|
|
|
|
|
+-----------------
|
|
|
|
|
+
|
|
|
|
|
+The Compact Box Docker image includes the following tools:
|
|
|
|
|
+
|
|
|
|
|
+* `bash`: The Bourne-Again SHell
|
|
|
|
|
+* `wget`: A command-line utility for downloading files from the web
|
|
|
|
|
+* `rsync`: A command-line utility for synchronizing files and directories
|
|
|
|
|
+* `mc`: The Midnight Commander file manager
|
|
|
|
|
+* `sudo`: A command-line utility for running commands with superuser privileges
|
|
|
|
|
+* `vim`: A text editor
|
|
|
|
|
+* `zip`: A command-line utility for compressing and decompressing files
|
|
|
|
|
+* `curl`: A command-line utility for transferring data to and from a web server
|
|
|
|
|
+
|
|
|
|
|
+**Volume Configuration**
|
|
|
|
|
+----------------------
|
|
|
|
|
+
|
|
|
|
|
+The image configures the `/mnt` directory with the following permissions:
|
|
|
|
|
+```bash
|
|
|
|
|
+chmod 755 /mnt
|
|
|
|
|
+```
|
|
|
|
|
+This allows the container to read and write files in the volume.
|
|
|
|
|
+
|
|
|
|
|
+**Default Command**
|
|
|
|
|
+------------------
|
|
|
|
|
+
|
|
|
|
|
+The default command for the container is `bash`, which logs you into the container as the root user.
|
|
|
|
|
+
|
|
|
|
|
+**Example Use Cases**
|
|
|
|
|
+--------------------
|
|
|
|
|
+
|
|
|
|
|
+* Examine the contents of a volume: `docker run -it --rm --name compact -v nc4_files:/mnt compact-box`
|
|
|
|
|
+* Copy files from the volume to the host machine: `docker run -it --rm --name compact -v nc4_files:/mnt compact-box rsync -av /mnt/ /host/path/`
|
|
|
|
|
+* Download a file from the web and save it to the volume: `docker run -it --rm --name compact -v nc4_files:/mnt compact-box wget -O /mnt/file.txt http://example.com/file.txt`
|