Yacy Search Server
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Go to file
Michael Christen 5cb7dc1fd7
Merge pull request #568 from joestr/patch-1
3 weeks ago
.github fixed condition in workflow 3 weeks ago
LICENSES creating LICENSES directory 2 years ago
addon attempt to make a Mac Release using gradle 1 year ago
bin fixed apicall call method parameters 2 years ago
defaults enabling new update location release.yacy.net 4 months ago
docker build fix 3 weeks ago
examples move example code SearchClient out of yacycore package 7 years ago
htroot larger link structure image 4 weeks ago
kubernetes removed Debian and Red Hat build process 2 years ago
langdetect Use language-detection library for increased accuracy 8 years ago
lib rm License files from lib/ folder 12 months ago
libbuild/J7Zip-modified Merge branch 'master' of https://github.com/yacy/yacy_search_server 4 months ago
libt use ivy to manage jars 12 months ago
locales removed ContentControl servlet and functinality 6 months ago
skins added stub of rc3assembly style 2 years ago
snap Added a stop command using the existing stop script to the snap package 4 years ago
source patched a 'java.lang.NoSuchMethodError: com.twelvemonkeys.imageio.util.IIOUtil.lookupProviderByName' problem which occurred only on ARM 3 weeks ago
test fix test xlsx file with correct anchor 1 year ago
vocabularies moved yacy.logging to defaults according to request in 11 years ago
.checkstyle problems with code style 14 years ago
.classpath moved more servlets to new location 6 months ago
.dockerignore fixed build problem from https://github.com/yacy/yacy_search_server/issues/566 3 weeks ago
.env Removed unnecessary variables for local heroku run 7 years ago
.gitignore changed system to load build properties 6 months ago
.project removed ContentControl servlet and functinality 6 months ago
.travis.yml removed Xms java memory startup parameter 2 years ago
AUTHORS added flori and me 15 years ago
CONTRIBUTING.md Add contributor guidelines; closes #214 5 years ago
COPYRIGHT updated copyright message; included LGPL for 'cora' and a warranty 10 years ago
Heroku.md fix typo 5 months ago
NOTICE * updated jxpath to latest v1.3 14 years ago
Procfile Simplified Heroku variables configuration 7 years ago
README.md replace Travis CI badge with GitHub CI badge 3 weeks ago
app.json Updated YaCy home page embedded links from http to https scheme 5 years ago
build.nsi fixed windows installer nsi file for latest release file names 6 months ago
build.properties new release number schema and CI processes: 6 months ago
build.xml turn compiler warnings on again 1 month ago
fixMacBuild.sh attempt to make a Mac Release using gradle 1 year ago
getWin32MaxHeap.bat update for memory observer algorithm 13 years ago
gpl.txt initial load with yacy 0.36 18 years ago
installYaCyWindowsService.bat removed Xms java memory startup parameter 2 years ago
ivy.xml possible fix for 6 months ago
killYACY.sh Fix for http://mantis.tokeek.de/view.php?id=432 9 years ago
lgpl21.txt migrated all my LGPL 3 -licensed files to the LGPL 2.1 because LGPL 3 is not compatible to the GPL 2 13 years ago
startYACY.bat for some strange reason there is no javaw in temurin, only java 6 months ago
startYACY.sh changed link to new forum location 1 year ago
startYACY_debug.bat changed link to new forum location 1 year ago
stopYACY.bat upd classpath in batches (remove not necessary htroot) 7 years ago
stopYACY.sh fixed apicall call method parameters 2 years ago
uninstallYaCyWindowsService.bat added Windows Service installer 9 years ago
updateYACY.sh fixed apicall call method parameters 2 years ago
yacy-packages.readme fix typo 5 months ago
yacy.yellow performance setting for remote indexing configuration and latest changes for 0.39 18 years ago



Gitter Build Status Install Link


What is this?

The YaCy search engine software provides results from a network of independent peers, instead of a central server. It is a distributed network where no single entity decides what to list or order it appears in.

User privacy is central to YaCy, and it runs on each user's computer, where search terms are hashed before they being sent to the network. Everyone can create their individual search indexes and rankings, and a truly customized search portal.

Each YaCy user is either part of a large search network (search indexes can be exchanged with other installation over a built-in peer-to-peer network protocol) or the user runs YaCy to produce a personal search portal that is either public or private.

YaCy search portals can also be placed in an intranet environment, making it a replacement for commercial enterprise search solutions. A network scanner makes it easy to discover all available HTTP, FTP and SMB servers.

To create a web index, YaCy has a web crawler for everybody, free of censorship and central data retention:

  • Search the web (automatically using all other YaCy peers)
  • Co-operative crawling; support for other crawlers
  • Intranet indexing and search
  • Set up your own search portal
  • All users have equal rights
  • Comprehensive concept to anonymize the users' index

To be able to perform a search using the YaCy network, every user has to set up their own node. More users means higher index capacity and better distributed indexing performance.


This project is available as open source under the terms of the GPL 2.0 or later. However, some elements are being licensed under GNU Lesser General Public License. For accurate information, please check individual files. As well as for accurate information regarding copyrights. The (GPLv2+) source code used to build YaCy is distributed with the package (in /source and /htroot).

Where is the documentation?

All these have (YaCy) search functionality combining all these locations into one search result.

Dependencies? What other software do I need?

You need Java 1.8 or later to run YaCy. (No Apache, Tomcat or MySQL or anything else)

YaCy also runs on IcedTea 3. See https://icedtea.classpath.org

Start and stop it

Startup and shutdown:

  • GNU/Linux and OpenBSD:

    • Start by running ./startYACY.sh
    • Stop by running ./stopYACY.sh
  • Windows:

    • Start by double-clicking startYACY.bat
    • Stop by double-clicking stopYACY.bat
  • macOS: Please use the Mac app and start or stop it like any other program (double-click to start)

The administration interface

A web server is brought up after starting YaCy. Open this URL in your web-browser:


This presents you with the personal search and administration interface.

(Headless) YaCy server installation

YaCy will authorize users automatically if they access the server from its localhost. After about 10 minutes a random password is generated, and then it is no longer possible to log in from a remote location. If you install YaCy on a server that is not your workstation you must set an admin account immediately after the first start-up. Open:


and set an admin account.

YaCy in a virtual machine or a container

Use virtualization software like VirtualBox or VMware.

The following container technologies can deploy locally, on remote machines you own, or in the 'cloud' using a provider by clicking "Deploy" at the top of the page:


More details in the docker/Readme.md.


PaaS (Platform as a service) More details in Heroku.md.

Port 8090 is bad, people are not allowed to access that port

You can forward port 80 to 8090 with iptables:

iptables -t nat -A PREROUTING -p tcp --dport 80 -j REDIRECT --to-port 8090

On some operating systems, access to the ports you are using must be granted first:

iptables -I INPUT -m tcp -p tcp --dport 8090 -j ACCEPT

Scaling, RAM and disk space

You can have many millions web pages in your own search index. By default, 600MB RAM is available to the Java process. The GC process will free the memory once in a while. If you have less than 100000 pages you could try 200MB till you hit 1 million. Here you can adjust it. Several million web pages may use several GB of disk space, but you can adjust it here to fit your needs.

Help develop YaCy

Join the large number of contributors that make YaCy what it is; community software.

To start developing YaCy in Eclipse:

  • clone https://github.com/yacy/yacy_search_server.git using build-in Eclipse features (File -> Import -> Git)
  • or download source from this site (download button "Code" -> download as Zip -> and unpack)
  • import a Gradle project (File -> Import -> Gradle -> Existing Gradle Project)
  • in the tab "Gradle Tasks" are tasks available to use build the project (e.g. build -> build or application -> run)

To start developing YaCy in Netbeans:

  • clone https://github.com/yacy/yacy_search_server.git (Team → Git → Clone)
    • if you checked "scan for project" you'll be asked to open the project
  • Open the project (File → Open Project)
  • you may directly use all the Netbeans build feature.

To join our development community, got to https://community.searchlab.eu

Send pull requests to https://github.com/yacy/yacy_search_server

Compile from source

The source code is bundled with every YaCy release. You can also get YaCy from https://github.com/yacy/yacy_search_server by cloning the repository.

git clone https://github.com/yacy/yacy_search_server

Compiling YaCy:

  • You need Java 1.8 and ant
  • See ant -p for the available ant targets

APIs and attaching software

YaCy has many built-in interfaces, and they are all based on HTTP/XML and HTTP/JSON. You can discover these interfaces if you notice the orange "API" icon in the upper right corner of some web pages in the YaCy web interface. Click it, and you will see the XML/JSON version of the respective webpage. You can also use the shell script provided in the /bin subdirectory. The shell scripts also call the YaCy web interface. By cloning some of those scripts you can easily create more shell API access methods.


Visit the international YaCy forum where you can start a discussion there in your own language.

Questions and requests for paid customization and integration into enterprise solutions. can be sent to the maintainer, Michael Christen per e-mail (at mc@yacy.net) with a meaningful subject including the word 'YaCy' to prevent it getting stuck in the spam filter.

  • Michael Peter Christen