Skip to content

Commit

Permalink
removed wiki links and added more shields badges
Browse files Browse the repository at this point in the history
  • Loading branch information
@Orbiter
Orbiter committed Sep 30, 2023
1 parent ca2a210 commit 095a444
Showing 1 changed file with 40 additions and 129 deletions.
169 changes: 40 additions & 129 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,11 @@

Search Engine Software

[![Gitter](https://badges.gitter.im/yacy/yacy_search_server.svg)](https://gitter.im/yacy/yacy_search_server?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![YaCy Home Page](https://img.shields.io/badge/YaCy%20Home%20Page-5090D0)](https://yacy.net)
[![YaCy Discourse Forums](https://img.shields.io/discourse/status?server=https%3A%2F%2Fcommunity.searchlab.eu%2F&label=YaCy%20Discourse%20Forums)](https://community.searchlab.eu/)
[![become a Github Sponsor](https://img.shields.io/badge/Become_a_Github_Sponsor-for_YaCy-green)](https://github.com/sponsors/Orbiter)
[![become a Patreon Member](https://img.shields.io/badge/Become_a_Patreon_Member-for_YaCy-green)](https://www.patreon.com/bePatron?u=185903)
[![Build Status](https://github.com/yacy/yacy_search_server/actions/workflows/ant-build-selfhosted.yaml/badge.svg)](https://github.com/yacy/yacy_search_server/actions/workflows/ant-build-selfhosted.yaml)
[![Install Link](https://img.shields.io/badge/install-stable-blue.svg)](https://yacy.net/download_installation/)

Expand Down Expand Up @@ -41,120 +45,52 @@ mode in the web interface. You can also opt-out from the network in individual s
turning the use of YaCy a completely privacy-aware tool - in this operation mode search
results are computed from the local index only.

## License

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?

- [Homepage](https://yacy.net)
- [International Forum](https://community.searchlab.eu)
- [Documentation / FAQ](https://yacy.net/faq/)
- [English wiki](https://wiki.yacy.net/index.php/En:Start)
- [German wiki](https://wiki.yacy.net/index.php/De:Start)
- [Esperanto wiki](https://wiki.yacy.net/index.php/Eo:Start)
- [French wiki](https://wiki.yacy.net/index.php/Fr:Start)
- [Spanish wiki](https://wiki.yacy.net/index.php/Es:Start)
- [Russian wiki](https://wiki.yacy.net/index.php/Ru:Start)
- [Video tutorials](https://www.youtube.com/@YaCyTutorials/videos)
- [javadoc documentation](https://yacy.net/api/javadoc/) for developers

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

## Dependencies? What other software do I need?

You need Java 11 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:
## Installation

- GNU/Linux and OpenBSD:
- Start by running `./startYACY.sh`
- Stop by running `./stopYACY.sh`
We recommend to compile YaCy yourself and install it from the git sources.
Pre-compiled YaCy packages exist but are not generated on a regular basis.
To get a ready-to-run production package, run YaCy from Docker.

- Windows:
- Start by double-clicking `startYACY.bat`
- Stop by double-clicking `stopYACY.bat`
### Compile and run YaCy from git sources

- macOS:
Please use the Mac app and start or stop it like any
other program (double-click to start)
You need Java 11 or later to run YaCy, nothing else. The following works with linux and with MacOS:

```
git clone --depth 1 https://github.com/yacy/yacy_search_server.git
cd yacy_search_server
ant clean all
```

## The administration interface

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

http://localhost:8090

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:

http://<remote-server-address>:8090/ConfigAccounts_p.html

and set an admin account.

## YaCy in a virtual machine or a container

Use virtualization software like VirtualBox or VMware.
To start YaCy, run

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:
```
./startYACY.sh
```

### Docker
The administration interface is then available in your web browser at `http://localhost:8090`.
Some of the web pages are protected and need an administration account; these pages are usually
also available without a password from the localhost, but remote access needs a log-in.
The default admin account name is `admin` and the default password is `yacy`.
Please change it after installation using the ``http://<server-address>:8090/ConfigAccounts_p.html`` service.

More details in the [docker/Readme.md](docker/Readme.md).
Stop YaCy on the console with
```
./stopYACY.sh
```

### [Heroku](https://www.heroku.com/)
### Run YaCy using Docker

PaaS (Platform as a service)
More details in [Heroku.md](Heroku.md).
The Official YaCy Image is `yacy/yacy_search_server:latest`. It is hosted on Dockerhub at [https://hub.docker.com/r/yacy/yacy_search_server](https://hub.docker.com/r/yacy/yacy_search_server)

## Port 8090 is bad, people are not allowed to access that port
To install YaCy in intel-based environments, run:

You can forward port 80 to 8090 with iptables:
```bash
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:
```bash
iptables -I INPUT -m tcp -p tcp --dport 8090 -j ACCEPT
docker run -d --name yacy_search_server -p 8090:8090 -p 8443:8443 -v yacy_search_server_data:/opt/yacy_search_server/DATA --restart unless-stopped --log-opt max-size=200m --log-opt max-file=2 yacy/yacy_search_server:latest
```

## 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](http://localhost:8090/Performance_p.html) you can adjust it.
Several million web pages may use several GB of disk space, but you can
adjust it [here](http://localhost:8090/ConfigHTCache_p.html) to fit your needs.

then open http://localhost:8090 in your web-browser.

## 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)
- Open Help -> Eclipse Marketplace -> Search for "ivy" -> Install "Apache IvyDE"
Expand All @@ -164,40 +100,10 @@ This will build YaCy in Eclipse. To run YaCy:
- Package Explorer -> YaCy: navigate to source -> net.yacy
- right-click on yacy.java -> Run as -> Java Application


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
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 11, ivy and ant
- See `ant -p` for the available ant targets
```
ant clean dist
```
resulting tar.gz with YaCy package will be located in RELEASE/ directory.
Move it into desired location and unpack with:
```
tar zfvx yacy_v1.version_release_number_different_each_time.tar.gz
```

## APIs and attaching software

YaCy has many built-in interfaces, and they are all based on HTTP/XML and
Expand All @@ -208,6 +114,11 @@ 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.

## License

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).

## Contact

[Visit the international YaCy forum](https://community.searchlab.eu)
Expand Down

0 comments on commit 095a444

Please sign in to comment.