Browse Source

Add example config file

Aaron Lindsay 6 years ago
parent
commit
165539f135
1 changed files with 121 additions and 0 deletions
  1. 121 0
      example_config

+ 121 - 0
example_config

@@ -0,0 +1,121 @@
1
+# Copyright (C) 2013 Aaron Lindsay <aaron@aclindsay.com>
2
+#
3
+# An example Asink configuration file. The `asink' command will search
4
+# for this file at ~/.asink/config. If you want to keep it somewhere
5
+# else, you must run the `asink' command with the `-c' option:
6
+#     asink -c /path/to/your/config
7
+#
8
+# This file must remain only readable and writable only by the user
9
+# running the Asink client (i.e. `chmod 600 config`) because it contains
10
+# passwords and encryption keys.
11
+
12
+
13
+########################################################################
14
+# The [local] section controls things which are independent of the rest
15
+# of the system (i.e. you can change these settings and not have to
16
+# change anything with your server configuration, or the config on any
17
+# of the other clients)
18
+########################################################################
19
+[local]
20
+
21
+# The directory you want to keep synchronized between your computers
22
+syncdir = /home/user1/Asink
23
+
24
+## The following directories/files are all typically located inside a
25
+## .asink folder in your home directory.
26
+
27
+# A directory to store locally-cached versions of files.
28
+cachedir = /home/user1/.asink/cache
29
+
30
+# A temporary directory used by Asink when it needs to make temporary
31
+# files
32
+tmpdir = /home/user1/.asink/cache/.tmpdir
33
+
34
+# Where you want to store the SQLite database used by the Asink client
35
+dblocation = /home/user1/.asink/localdb.db
36
+
37
+# The socket to be used to communicate with the Asink client
38
+socket = /home/user1/.asink/asink.sock
39
+
40
+########################################################################
41
+# The [server] section controls how the Asink client communicates with
42
+# the Asink server (`asinkd')
43
+########################################################################
44
+[server]
45
+
46
+# The IP address or hostname of your Asink server (`asinkd')
47
+host = example.com
48
+
49
+# The port used to communicate with asinkd (i.e. 'asinkd -p 8080')
50
+port = 8080
51
+
52
+# Your user's username and password for communicating with the server
53
+# These can be set using the asinkd 'useradd', 'usermod', and 'userdel'
54
+# commands.
55
+username = user1
56
+# Don't surround with quotes unless your password contains them
57
+password = user1password
58
+
59
+########################################################################
60
+# The [storage] section controls how/where your files are stored (The
61
+# server mentioned above only handles keeping track of file versions, it
62
+# doesn't actually store them). Asink supports several different types
63
+# of storage providers, and which options are available to you in this
64
+# section varies depending on which storage provider you use.
65
+#
66
+# The current storage options are:
67
+#  local
68
+#  FTP
69
+#
70
+# Be sure you only uncomment one of the following "method = ..." lines
71
+# along with its corresponding options.
72
+########################################################################
73
+[storage]
74
+
75
+
76
+## Local storage ##
77
+# Local storage is useful if you want to back your files up to a NFS
78
+# share or something you can mount locally (and also for testing Asink
79
+# with only one machine).
80
+method = local
81
+
82
+# The directory to store files in
83
+dir = /home/user1/.asink/localstorage
84
+
85
+
86
+## FTP storage ##
87
+#method = ftp
88
+
89
+# The hostname or IP address of the FTP server
90
+#server = localhost
91
+
92
+# The remote port the FTP server is using
93
+# port = 21
94
+
95
+# The directory on the server you want to store your files in
96
+#directory = asink_ftp
97
+
98
+# The username and password used to connect to the FTP server
99
+#username = user1
100
+# Don't surround with quotes unless your password contains them
101
+#password = user1password
102
+
103
+
104
+########################################################################
105
+# The [encryption] section controls whether or not files are encrypted,
106
+# and supplies the encryption key if they are.
107
+########################################################################
108
+[encryption]
109
+
110
+# 'yes' if encryption is enabled and 'no' otherwise
111
+enabled = yes
112
+
113
+# The key only needs to be supplied if encryption is enabled. This
114
+# currently cannot be changed once you begin synchronizing files, so
115
+# choose it carefully. In the future, there will most likely be an
116
+# option to change the encryption key, but it will involve downloading,
117
+# decrypting, re-encrypting, and re-uploading all the versions of all
118
+# your files, so it will be a time-intensive operation.
119
+#
120
+# Note: The key should not be surrounded by quotes
121
+key = user1encryptionkey