Skip to content

Commit 9578959

Browse files
committed
Cleaned up instructions a bit.
1 parent d5b1b36 commit 9578959

File tree

2 files changed

+53
-15
lines changed

2 files changed

+53
-15
lines changed

README.md

+53-15
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,72 @@
11
# docker-timemachine
22
A docker container to compile the lastest version of Netatalk in order to run a Time Machine server.
33

4+
45
## Installation
56

7+
### Step 1 - Start the Server
8+
69
To download the docker container and execute it, simply run:
710

811
```
9-
$ docker run -h timemachine --name timemachine --restart=unless-stopped -d -v /route/to/your/timemachine:/timemachine -it -p 548:548 -p 636:636 odarriba/timemachine
12+
$ docker run -h timemachine --name timemachine --restart=unless-stopped -d -v /external_volume:/timemachine -it -p 548:548 -p 636:636 odarriba/timemachine
1013
```
1114

12-
To add users, just run this command:
15+
Replace `external_volume` with a local path where you want to store your data.
16+
17+
As the image has been started using the `--restart=always` flag, it will start when the computers boots up.
18+
19+
20+
21+
### Step 2 - Add a User
22+
23+
To add a user, run:
1324

1425
```
1526
$ docker exec timemachine add-account USERNAME PASSWORD MOUNT_POINT [VOL_SIZE_MB]
1627
```
1728

1829
But take care that:
19-
* `MOUNT_POINT` should be an absolute path, preferably inside `/timemachine`, so it will be stored in your external volume.
30+
* `MOUNT_POINT` should be an absolute path, preferably set it to `"/timemachine"`, so it will be stored right in your external volume.
2031
* `VOL_SIZE_MB` is an optional parameter. It indicates the max volume size for that user.
2132

2233
Now you have a docker instance running `netatalk`.
2334

35+
36+
### Step 3 - Enable Auto Discovery
37+
38+
Avahi daemon is commonly used to help your computers to find the services provided by a server.
39+
40+
Avahi isn't built into this Docker image because, due to Docker's networking limitations, Avahi can't spread it's messages to announce the services.
41+
42+
**If you want to enable this feature, you can install Avahi daemon on your host** following these steps (Ubuntu version):
43+
44+
* Install `avahi-daemon`: run `sudo apt-get install avahi-daemon avahi-utils`
45+
* Copy the file from `avahi/nsswitch.conf` to `/etc/nsswitch.conf`
46+
* Copy the service description file from `avahi/afpd.service` to `/etc/avahi/services/afpd.service`
47+
* Restart Avahi's daemon: `sudo /etc/init.d/avahi-daemon restart`
48+
49+
50+
### Step 4 - Start Using It
51+
52+
To start using it, follow these steps:
53+
54+
* If you use Avahi, open **Finder**, go to **Shared** and connect to your server with your new username and password. Alternatively, or if you don't use Avahi, from **Finder** press **CMD-K** and type `afp://your-server-name`.
55+
56+
* Go to **System Preferences**, and open **Time Machine** settings.
57+
58+
* Open **Add or Remove Backup Disk...**
59+
60+
* Select your new volume.
61+
62+
63+
In the example below, the Docker instance is running on server `central`. For `USERNAME` the account `Backup` along with a `PASSWORD`. Once connected, the account `Backup` is available in Time Machine settings.
64+
65+
![alt text](docs/overview.jpg "Getting Started")
66+
67+
68+
## Advanced Usage
69+
2470
### Configure using environment variables
2571

2672
You can configure the container using environment variables (for example, if you use a `docker-compose` environment).
@@ -34,24 +80,16 @@ There are these environment variables:
3480

3581
Using these variables, the container will create a user at boot time (only one per container).
3682

37-
## Auto-discovering
3883

39-
Avahi daemon is commonly used to help your computers to find the services provided by a server.
84+
## FAQ
4085

41-
Avahi isn't built into this Docker image because, due to Docker's networking limitations, Avahi can't spread it's messages to announce the services.
42-
43-
**If you want to enable this feature, you can install Avahi daemon on your host** following these steps (Ubuntu version):
86+
#### I don't find the service in Time Machine.
4487

45-
* Install `avahi-daemon`: run `sudo apt-get install avahi-daemon avahi-utils`
46-
* Copy the file from `avahi/nsswitch.conf` to `/etc/nsswitch.conf`
47-
* Copy the service description file from `avahi/afpd.service` to `/etc/avahi/services/afpd.service`
48-
* Restart Avahi's daemon: `sudo /etc/init.d/avahi-daemon restart`
4988

50-
**But why install this on your host and not in the container?** Because if you don't do it this way, the discovery message won't be able to reach your computers.
89+
#### Why do I need to install Avahi on your host and not in the container?
90+
Because if you don't do it this way, the discovery message won't be able to reach your computers.
5191

52-
## Auto start the service
5392

54-
As the image has been started using the `--restart=always` flag, it will start when the computers boots up.
5593

5694
## Contributors
5795

docs/overview.jpg

96.3 KB
Loading

0 commit comments

Comments
 (0)