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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
# Yacy Docker image from latest sources
## Supported tags and respective Dockerfiles
* latest (Dockerfile)
* latest-alpine (Dockerfile.alpine)
## Getting built image from Docker Hub
The repository URL is https://hub.docker.com/r/yacy/yacy_search_server/
* ubuntu-based: `docker pull yacy/yacy_search_server:latest`
* alpine-based: `docker pull yacy/yacy_search_server:latest-alpine`
## Building image yourself
Using files in 'yacy_search_server/docker/':
```
cd yacy_search_server/docker
```
Then according to the image type:
* for ubuntu-based images:
```
docker build -t yacy/yacy_search_server:latest -f Dockerfile ../
```
* To build the Alpine variant:
```
docker build -t yacy/yacy_search_server:alpine-latest -f Dockerfile.alpine ../
```
## Image variants
* `yacy/yacy_search_server:latest`: This image is based on latest stable official Debian stable [openjdk](https://hub.docker.com/_/openjdk/) 8 image provided by Docker. Embed Yacy compiled from latest git repository sources.
* `yacy/yacy_search_server:latest-alpine`: This image is based on latest stable official Alpine Linux [openjdk](https://hub.docker.com/_/openjdk/) 8 image provided by Docker. Embed Yacy compiled from latest git repository sources.
## Default admin account
* login: admin
* password: yacy
You should modify this default password with page /ConfigAccounts_p.html when exposing publicly your YaCy container.
## Usage
### First start
#### Most basic
docker run yacy/yacy_search_server
YaCy web interface is then exposed at http://[container_ip]:8090
You can retrieve the container IP address with `docker inspect`.
#### Easier to handle
docker run --name yacy -p 8090:8090 -p 8443:8443 --log-opt max-size=200m --log-opt max-file=2 yacy/yacy_search_server
##### Options detail
* --name: allow easier management of your container (without it, docker automatically generate a new name at each startup).
* -p 8090:8090 -p 8443:8443: map host ports to YaCy container ports, allowing web interface access through the usual http://localhost:8090 and https://localhost:8443 (you can set a different mapping, for example -p 443:8443 if you prefer to use the default HTTPS port on your host)
* --log-opt max-size: limit maximum docker log file size for this container
* --log-opt max-file: limit number of docker rotated log files for this container
Note: if you do not specify the log related options, when running a YaCy container 24hour a day with default log level, your Docker container log file will grow up to some giga bytes in a few days!
#### Handle persistent data volume
As configured in the Dockerfile, by default yacy data (in /opt/yacy_search_server/DATA) will persist after container stop or deletion, in a volume with an automatically generated id.
But you may map a host directory to hold yacy data in container:
docker run -v [/your_host/data/directory]:/opt/yacy_search_server/DATA yacy/yacy_search_server
Or just use a volume label to help identify it later
docker run -v yacy_volume:/opt/yacy_search_server/DATA yacy/yacy_search_server
Note that you can list all docker volumes with:
docker volume ls
#### Start as background process
docker run -d yacy/yacy_search_server
### HTTPS support
This images are default configured with HTTPS enabled, and use a default certificate stored in defaults/freeworldKeystore. You should use your own certificate. In order to do it, you can proceed as follow.
#### Self-signed certificate
A self-signed certificate will provide encrypted communications with your YaCy server, but browsers will still complain about an invalid security certificate with the error "SEC_ERROR_UNKNOWN_ISSUER". If it is sufficient for you, you can permanently add and exception to your browser.
This kind of certificate can be generated and added to your YaCy Docker container with the following:
keytool -keystore /var/lib/docker/volumes/[your_yacy_volume]/_data/SETTINGS/yacykeystore -genkey -keyalg RSA -alias yacycert
Then edit YaCy config file. For example with the nano text editor:
nano /var/lib/docker/volumes/[your_yacy_volume]/_data/SETTINGS/yacy.conf
And configure the keyStoreXXXX properties accordingly:
keyStore=/opt/yacy_search_server/DATA/SETTINGS/yacykeystore
keyStorePassword=yourpassword
#### Import an existing certificate:
Importing a certificate validated by a certification authority (CA) will ensure you have full HTTPS support with no security errors when accessing your YaCy peer. You can import an existing certificate in pkcs12 format.
First copy it to the YaCy Docker container volume:
cp [yourStore].pkcs12 /var/lib/docker/volumes/[your_yacy_volume]/_data/SETTINGS/[yourStore].pkcs12
Then edit YaCy config file. For example with the nano text editor:
nano /var/lib/docker/volumes/[your_yacy_volume]/_data/SETTINGS/yacy.conf
And configure the pkcs12XXX properties accordingly:
pkcs12ImportFile=/opt/yacy_search_server/DATA/SETTINGS/[yourStore].pkcs12
pkcs12ImportPwd=yourpassword
### Next starts
#### As attached process
docker start -a yacy
#### As background process
docker start yacy
### Shutdown
* Use "Shutdown" button in administration web interface
* OR run:
docker exec [your_container_name] /opt/yacy_search_server/stopYACY.sh
* OR run:
docker stop [your_container_name]
### Upgrade
You can upgrade your YaCy container the Docker way with the following commands sequence.
Get latest Docker image:
docker pull yacy/yacy_search_server:latest
OR
docker pull yacy/yacy_search_server:latest-alpine
Create new container based on pulled image, using volume data from old container:
docker create --name [tmp-container_name] -p 8090:8090 -p 8443:8443 --volumes-from=[container_name] --log-opt max-size=100m --log-opt max-file=2 yacy/yacy_search_server:latest
Stop old container:
docker exec [container_name] /opt/yacy_search_server/stopYACY.sh
Start new container:
docker start [tmp-container_name]
Check everything works fine, then you can delete old container:
docker rm [container_name]
Rename new container to reuse same container name:
docker rename [tmp-container_name] [container_name]
## License
View [license](https://github.com/yacy/yacy_search_server/blob/master/COPYRIGHT) information for the software contained in this image.
|
