From ef552ee73e26d2bd340e57c8bb2a5fdbf7d51900 Mon Sep 17 00:00:00 2001 From: kjake Date: Mon, 25 Mar 2024 00:39:55 -0400 Subject: [PATCH] Update README.md [skip ci] --- README.md | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 2cace88..75bff61 100644 --- a/README.md +++ b/README.md @@ -6,16 +6,20 @@ A container serving [Apple Filing Protocol](https://en.wikipedia.org/wiki/Apple_ To quickly get started with running an [Netatalk] container first you can run the following command: -```bash -docker run --detach --publish 548:548 kjake/netatalk:latest +```shell +docker run --detach \ +--publish 548:548 kjake/netatalk:latest ``` **Important:** This does not announce the AFP service on the network; connecting to the server should be performed by Finder's `Go -> Connect Server (CMD+K)` and then typing `afp://[docker_host]`. Default configuration of [Netatalk] has two share called _Share_ which shares the containers `/media/share` and called _TimeMachine_ which shares the containers `/media/timemachine` mounting point. Host mounting a volume to this path will be the quickest way to start sharing files on your network. -```bash -docker run --detach --volume [host_path]:/media/share --volume [host_path]:/media/timemachine --publish 548:548 kjake/netatalk:latest +```shell +docker run --detach \ +--volume [host_path]:/media/share \ +--volume [host_path]:/media/timemachine \ +--publish 548:548 kjake/netatalk:latest ``` ## The slower road @@ -30,8 +34,12 @@ There are two ways of configuring the [Netatalk] which is either by mounting a c This is quite a simple way to change the configuration by supplying an additional docker flag when creating the container. -```bash -docker run --detach --volume [host_path]:/etc/afp.conf --volume [host_path]:/media/share --volume [host_path]:/media/timemachine --publish 548:548 kjake/netatalk:latest +```shell +docker run --detach \ +--volume [host_path]:/etc/afp.conf \ +--volume [host_path]:/media/share \ +--volume [host_path]:/media/timemachine \ +--publish 548:548 kjake/netatalk:latest ``` #### Container edited configuration @@ -51,7 +59,7 @@ To setup access credentials you should supply the following environment variable #### Example -```bash +```shell docker run --detach \ --volume /mnt/sda1/share:/media/share \ --net "host" \