Skip to content

Commit

Permalink
solved conflicts for merging #6, transfered typo-fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
okybaca committed Feb 13, 2025
1 parent 04023a3 commit 46873c7
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 21 deletions.
18 changes: 11 additions & 7 deletions docs/demonstration_tutorial_screenshot.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ We have screenshots, tutorial movies, and a live demonstration. If you want to j

### Search Results

This is the search result page using peer-to-peer data:
This is the search results page using peer-to-peer data:
![YaCy Search Engine Result List](img/screenshot_search_result.png)

Search result pages can be configured:
Expand All @@ -27,7 +27,7 @@ Search result ranking can be configured:

### Crawling

Before search resuls can be provided, a web crawl must be done to harvest the required document corpus.
Before search results can be provided, a web crawl must be done to harvest the required document corpus.

There is a easy-to-use simple crawl start service which takes almost only the starting URL as input:
![YaCy Search Engine Site Crawler/Spider](img/screenshot_crawler_site.png)
Expand All @@ -41,7 +41,7 @@ For more complex harvesting tasks, here is the Expert Crawl Start service:

### Data Analysis

A running YaCy instance has many management tasks runnning and it creates a lot of data.
A running YaCy instance has many management tasks running and it creates a lot of data.
To visualize that data about itself and the data it harvested from the internet, there are a lot of
dashboards and monitoring features.

Expand All @@ -51,7 +51,8 @@ The status page which informs about the current activities of your YaCy instance
Crawled web pages can be reconstructed and browsed with the host browser where you see the internal link structure and all kind of details of the parsing results:
![YaCy Search Engine Host Browser](img/screenshot_host_browser.png)

While the host browser reveals the structure of documents within all of the single domains, the web strucure service shows how domains are linked to each other:
While the host browser reveals the structure of documents within all of the single domains, the web
structure service shows how domains are linked to each other:
![YaCy Search Engine Web Structure](img/screenshot_web_structure.png)

### Configuration
Expand All @@ -61,7 +62,10 @@ YaCy can be configured in every detail using the web interface. You can use a co
Here you see the use case configuration. This is actually the first service which YaCy shows to you because the first thing you have to do is to choose which use case you are prefering: Peer-to-Peer operation, your own Search Portal, or Intranet Indexing:
![YaCy Search Engine Basic Configuration for Use Case: Peer-to-Peer, Portal, Intranet](img/screenshot_use_case_configuration.png)

The main purpose of YaCy is to aquire a lot of data from the web and make them searchable. Consequently, this uses a lot of disk space. We make the resources which YaCy takes configurable with the following service. YaCy loves to use more RAM if available, give it more RAM and it performes better!
The main purpose of YaCy is to aquire a lot of data from the web and make
them searchable. Consequently, this uses a lot of disk space. We make the
resources which YaCy takes configurable with the following service. YaCy
loves to use more RAM if available, give it more RAM and it performs better!
![YaCy Search Engine Performance Setting](img/screenshot_performance_settings.png)


Expand All @@ -81,7 +85,7 @@ Every connection that YaCy does, peer-to-peer or crawling, is monitored as well:

## Tutorial Movies

We have a youtube channel! Yes, thats a google service - therefore all videos embedded here are mouseover-activated, that means as long as you do not touch them, there is no referrer appearing at a G server.
We have a YouTube channel! Yes, thats a Google service - therefore all videos embedded here are mouseover-activated, that means as long as you do not touch them, there is no referrer appearing at a G server.

These videos are short and most have nice music from [Shiryu Music](https://shiryu.bandcamp.com/) in the background. Shiryu is just great and inspiring!

Expand Down Expand Up @@ -129,7 +133,7 @@ Instead of Java 7 now please install Java 11 (or higher)
<img src="../img/tutorial_06_Secret_Agents_with_YaCy_RSS_Feed_Reader.png" alt="YaCy Tutorial 06: Secret Agents with YaCy RSS Feed Reader" width="720" height="405" onmouseover="document.getElementById('video06').innerHTML = embed06;">
</div>

### Demo: Location Search with YaCy and Opensteetmap and Geonames
### Demo: Location Search with YaCy and Openstreetmap and Geonames
<div id="video07">
<img src="../img/tutorial_07_Search_Locations_on_Map_with_Openstreetmap_and_Geonames.png" alt="YaCy Tutorial 07: Search Locations on a Map with Openstreetmap and Geonames" width="720" height="405" onmouseover="document.getElementById('video07').innerHTML = embed07;">
</div>
Expand Down
24 changes: 13 additions & 11 deletions docs/download_installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Because YaCy requires Java, first download and install Java (>= Java 11) from [h
### With Docker

If you run YaCy with Docker you don't need to install Java on your system, it's all contained in the Coder Container.
If you don't hava Docker installed, get it from [https://docs.docker.com/get-docker/](https://docs.docker.com/get-docker/) (for macOS, Windows and Linux) or read the instructions from [https://www.docker.com/blog/getting-started-with-docker-for-arm-on-linux/](https://www.docker.com/blog/getting-started-with-docker-for-arm-on-linux/) to install Docker on Raspberry Pi or any other ARM-based devices.
If you don't hava Docker installed, get it from [https://docs.docker.com/get-docker/](https://docs.docker.com/get-docker/) (for macOS, Windows and Linux) or read the instructions from [https://www.docker.com/blog/getting-started-with-docker-for-arm-on-linux/](https://www.docker.com/blog/getting-started-with-docker-for-arm-on-linux/) to install Docker on Raspberry Pi or other ARM-based devices.


## Download
Expand Down Expand Up @@ -46,13 +46,13 @@ The source code is inside the generic tarball. It is recommended you clone the G
### On Windows

* Double-clicking the downloaded installer.
* When the message `Windows protected your PC` (in Windows 10) appears, klick `More info`->`Run anyway`.
* When asked `Do you want to allow this app from an unknown publisher to make changes to your device`, klick `yes`.
* Within the YaCy Installer, klick `Next`, `I Agree`, `Next`, `Install`, `Finish`.
* When the message `Windows protected your PC` (in Windows 10) appears, click `More info`->`Run anyway`.
* When asked `Do you want to allow this app from an unknown publisher to make changes to your device`, click `yes`.
* Within the YaCy Installer, click `Next`, `I Agree`, `Next`, `Install`, `Finish`.
* To run YaCy, double-click the YaCy app icon (which may be on your desktop).
* Whenever the following dialog appears click `allow private networks` and `allow access`
![Windows Java Security Setting](img/win_java_security_dialog.png)
* YaCy is then running on port 8090 on your machine. Open [http://localhost:8090](http://localhost:8090) in your web-browser.
* YaCy is then running on port 8090 on your machine. Open [http://localhost:8090](http://localhost:8090) in your web browser.


### On Linux
Expand Down Expand Up @@ -109,7 +109,7 @@ i.e. to install YaCy in intel-based environments, run:
```
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
```
then open http://localhost:8090 in your web-browser.
then open http://localhost:8090 in your web browser.

The default login for YaCy on Docker is `admin`:`yacy`

Expand All @@ -132,7 +132,7 @@ For example: the default peer name can be set with `network.unit.agent` in `yacy
```
docker run -d --name yacy_search_server -p 8090:8090 -p 8443:8443 -e YACY_NETWORK_UNIT_AGENT=Choomba -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
```
This can also be used to re-start a previously started image to overwrite the already stored configuration values.
This can also be used to restart a previously started image to overwrite the already stored configuration values.

#### Backup and restore of DATA folder
All data from YaCy is written into the data folder which is stored in the docker volume `yacy_search_server_data`. To back-up that DATA folder to `/tmp/DATA.tar.gz`, just run
Expand All @@ -154,7 +154,7 @@ This will mount the data volume from the upgraded yacy instance.

When all works,

* YaCy is now running on port 8090 on your machine. Open [http://localhost:8090](http://localhost:8090) in your web-browser.
* YaCy is now running on port 8090 on your machine. Open [http://localhost:8090](http://localhost:8090) in your web browser.
* No password is required when accessing this YaCy instance from localhost. Howwever if you access your peer from another host, the default password for the account `admin` is `yacy`.

You should always set a new admin password!
Expand All @@ -172,7 +172,8 @@ You should always set a new admin password!

Installation is very easy on any system. If it looks complex here it's just because we give directions in great detail.

You can download and build your own YaCy with these simple steps. This is probably the best and easiest ways for everyone who knows how to use a command line interface.
You can download and build your own YaCy with these simple steps. This is probably the best and easiest way for
anyone who knows how to use a command line interface.

You need:

Expand Down Expand Up @@ -202,7 +203,7 @@ The compiled tarball will then be in the `RELEASE` folder.
# Kubernetes

```
# optional: for a quick and easy installation of Kubernetes, run minikube
# optional: for quick and easy installation of Kubernetes, run minikube
minikube start
minikube dashboard
Expand Down Expand Up @@ -234,7 +235,8 @@ config set-context --current --namespace=default

# Please Support YaCy

YaCy is libre software - licensed GPL-2+. Downloads are provided for free! Please consider becoming a permanent supporter of YaCy to ensure that YaCy can actively be developed!
YaCy is libre software - licensed GPL-2+. Downloads are provided for free! Please consider
to become a permanent supporter to ensure that YaCy can actively be developed!

## Become a YaCy Patron

Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@ There are these three use cases you can choose from:
<div id="mode-portal" class="col-md-4" style="background-color:#4E5D6C; margin-right:15px; padding-left:15px; padding-right:15px; position:relative; left:15px;">
<h2>Your Search Portal</h2>
<img src="img/usecase_webportal.png" alt="YaCy Use Case: Web Portal">
<p>Your YaCy installation is independent from other peers. Define your own web index and starting your own web crawl.</p>
<p>Your YaCy installation is independent from other peers. Define your own web index and start your own web crawl.</p>
</div>
<div id="mode-intranet" class="col-md-4" style="background-color:#4E5D6C; padding-left:15px; padding-right:15px; position:relative; left:15px;">
<h2>Intranet Search</h2>
<img src="img/usecase_intranet.png" alt="YaCy Use Case: Intranet">
<p>Create a search portal for your intranet or web pages or your (shared) file system.</p><br/>
<p>Create a search portal for your intranet, web pages or your (shared) file system.</p><br/>
</div>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/installation/headless.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,4 @@ The password is stored in hashed form in the file <yacy-home>DATA/SETTINGS/yacy.
* remove property adminAccount
* set property serverAccount to <account>:<password>, i.e. serverAccount=admin:mysecretpassword

When YaCy is started the next time, the serverAccount is encrypted and removed to prevent that the property is there in clear text form.
When YaCy is started the next time, the serverAccount is encrypted and removed to prevent that the property is there in cleartext form.

0 comments on commit 46873c7

Please sign in to comment.