summaryrefslogtreecommitdiffstats
path: root/pica-node.conf.5
blob: f0c7ff225e21a45839b4566f32c38c8318f95805 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
.TH pica-node.conf 5   
.SH NAME
pica-node.conf \- pica-node configuration file
.SH SYNOPSIS
.B /etc/pica-node.conf
.SH DESCRIPTION
.BR pica-node (8)
reads configuration data from 
.I /etc/pica-node.conf 
(or the 
file specified with -f on the command line). The file has .INI file format.
All options must be contained in 
.B [pica-node]
section. The possible options and their meanings are as follows:
.TP
.I announced_addr
Network address that can be used to reach this instance of pica-node. 
Can be specified in form of DNS name or IP  adress (Right now only IPv4
address format is supported. IPv6 and domain name support will be added in 
future releases). If the computer running pica-node is behind the NAT, external 
 public address of NAT machine must be specified and port forwarding must be 
 configured.
.TP
.I listen_port
Specifies the port number that 
.BR pica-node (8)
listens on.  The default is 2299
.TP
.I nodes_db_file
Specifies the nodes database file. This is the SQLite 3 database. It stores
info about available nodes (their address, port, last seen online, etc).
The default is 
.I /var/lib/pica-node/nodelist.db
.TP
.I CA_cert_file
Specifies the path to CA certificate in .pem format. The default is 
.I /usr/share/pica-node/CA.pem
.TP
.I disable_reserved_addrs
Disables usage of reserved IP ranges (127.0.0.0/8, 10.0.0.0/8, 192.168.0.0/16 and others).
If such address is received from other node or is set as "announced_addr" value, it will be 
rejected. This option can be set to "yes" or "no". Default is "yes".
.SH AUTHOR
Anton Sviridenko (anton (at) picapica.im, anton (at) picapica.ge)
.SH SEE ALSO
.BR pica-node (8)

.BR http://picapica.im