2016-05-13 14:32:54 +02:00
# Yacy Docker image from latest sources
2016-06-03 14:50:03 +02:00
## Supported tags and respective Dockerfiles
2016-06-02 10:03:28 +02:00
* latest (Dockerfile)
* lastet-alpine (Dockerfile.alpine)
2016-05-17 21:58:24 +02:00
## Getting built image from Docker Hub
2016-05-13 14:32:54 +02:00
docker pull luccioman/yacy
Repository URL : (https://hub.docker.com/r/luccioman/yacy/)
2016-05-17 21:58:24 +02:00
## Building image yourself
2016-05-13 14:32:54 +02:00
Using yacy_search_server/docker/Dockerfile :
cd yacy_search_server/docker
docker build .
2016-08-05 11:57:38 +02:00
To build the Alpine variant :
cd yacy_search_server/docker
docker build -f Dockerfile.alpine .
2016-06-02 10:03:28 +02:00
## Image variants
`luccioman/yacy:latest`
2018-10-17 08:42:31 +02:00
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.
2016-06-02 10:03:28 +02:00
`luccioman/yacy:latest-alpine`
2018-10-17 08:42:31 +02:00
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.
2016-06-02 10:03:28 +02:00
2016-05-17 21:58:24 +02:00
## Default admin account
2016-05-13 14:32:54 +02:00
login : admin
password : docker
You should modify this default password with page /ConfigAccounts_p.html when exposing publicly your YaCy container.
2016-05-17 21:58:24 +02:00
## Usage
2016-05-13 14:32:54 +02:00
2016-05-17 21:58:24 +02:00
### First start
2016-05-13 14:32:54 +02:00
2016-05-17 21:58:24 +02:00
#### Most basic
2016-05-13 14:32:54 +02:00
docker run luccioman/yacy
YaCy web interface is then exposed at http://[container_ip]:8090.
You can retrieve the container IP address with `docker inspect` .
2016-05-17 21:58:24 +02:00
#### Easier to handle
2016-05-13 14:32:54 +02:00
2016-08-05 11:57:38 +02:00
docker run --name yacy -p 8090:8090 -p 8443:8443 --log-opt max-size=200m --log-opt max-file=2 luccioman/yacy
2016-05-13 14:32:54 +02:00
2016-07-03 17:28:47 +02:00
##### Options detail
* --name : allow easier management of your container (without it, docker automatically generate a new name at each startup).
2016-08-05 11:57:38 +02:00
* -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)
2016-07-03 17:28:47 +02:00
* --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
2016-05-13 14:32:54 +02:00
2016-07-03 17:28:47 +02:00
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!
2016-05-13 14:32:54 +02:00
2016-05-31 09:51:17 +02:00
#### Handle persistent data volume
2016-05-13 14:32:54 +02:00
2016-05-31 09:51:17 +02:00
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.
2016-07-03 17:28:47 +02:00
But you may map a host directory to hold yacy data in container :
2016-05-31 09:51:17 +02:00
docker run -v [/your_host/data/directory]:/opt/yacy_search_server/DATA luccioman/yacy
Or just use a volume label to help identify it later
docker run -v yacy_volume:/opt/yacy_search_server/DATA luccioman/yacy
Note that you can list all docker volumes with :
docker volume ls
2016-05-13 14:32:54 +02:00
2016-08-05 12:16:11 +02:00
#### Start as background process
2016-05-13 14:32:54 +02:00
docker run -d luccioman/yacy
2016-08-05 11:57:38 +02:00
### HTTPS support
2016-08-05 12:16:11 +02:00
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.
2016-08-05 11:57:38 +02:00
#### Self-signed certificate
2016-08-05 12:16:11 +02:00
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.
2016-08-05 11:57:38 +02:00
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:
2016-08-05 12:16:11 +02:00
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.
2016-08-05 11:57:38 +02:00
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
2016-05-13 14:32:54 +02:00
2016-05-17 21:58:24 +02:00
### Next starts
2016-05-13 14:32:54 +02:00
2016-05-17 21:58:24 +02:00
#### As attached process
2016-05-13 14:32:54 +02:00
docker start -a yacy
2016-05-17 21:59:29 +02:00
#### As background process
2016-05-13 14:32:54 +02:00
docker start yacy
2016-05-17 21:58:24 +02:00
### Shutdown
2016-05-13 14:32:54 +02:00
2016-05-17 21:58:24 +02:00
* Use "Shutdown" button in administration web interface
2016-05-30 09:14:23 +02:00
* OR run :
2016-07-03 17:28:47 +02:00
docker exec [your_container_name] /opt/yacy_search_server/stopYACY.sh
2016-12-31 09:51:07 +01:00
* OR run :
docker stop [your_container_name]
2016-07-03 17:28:47 +02:00
### Upgrade
You can upgrade your YaCy container the Docker way with the following commands sequence.
Get latest Docker image :
docker pull luccioman/yacy:latest
OR
docker pull luccioman/yacy:latest-alpine
Create new container based on pulled image, using volume data from old container :
2016-09-06 00:06:02 +02:00
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 luccioman/yacy:latest
2016-07-03 17:28:47 +02:00
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]
2016-06-02 10:03:28 +02:00
## License
2016-06-03 14:50:03 +02:00
View [license ](https://github.com/yacy/yacy_search_server/blob/master/COPYRIGHT ) information for the software contained in this image.