Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
[skip ci]
  • Loading branch information
kjake committed Mar 25, 2024
1 parent a161167 commit ef552ee
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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" \
Expand Down

0 comments on commit ef552ee

Please sign in to comment.