Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Typo and grammar fixes in docs #6

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Typo and grammar fixes in docs #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/demonstration_tutorial_screenshot.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,7 @@ 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 +61,7 @@ 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 @@ -75,13 +75,13 @@ In case you are running YaCy in peer-to-peer operation, you can watch the networ
The peer-to-peer network can be investigated in detail in a table:
![YaCy Peer List Table](img/screenshot_peer_list.png)

Every connection that YaCy does, peer-to-peer or crawling, is monitored as well:
Every connection that YaCy does: peer-to-peer or crawling, is monitored as well:
![YaCy Network Monitor](img/screenshot_access_grid.png)


## 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 +129,7 @@ Instead of Java-7 now please install Java-8
<img src="../img/tutorial_06_Secret_Agents_with_YaCy_RSS_Feed_Reader.png" 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" width="720" height="405" onmouseover="document.getElementById('video07').innerHTML = embed07;">
</div>
Expand Down
20 changes: 10 additions & 10 deletions docs/download_installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Download and Installation of YaCy


YaCy is available as packages for Linux, Windows, Macintosh and also as Docker Image. You can also install YaCy on any other operation system either by compiling it yourself or using a tarball. YaCy needs Java 8, OpenJDK 8 is recommended.
YaCy is available as packages for Linux, Windows, Macintosh and also as Docker Image. You can also install YaCy on any other operation system either by compiling it yourself or using a tarball. YaCy needs Java 8 (OpenJDK 8 is recommended).

<p><a class="btn btn-default btn-sm pull-right" href="https://github.com/yacy/yacy_net_homepage/blob/master/docs/download_installation.md" role="button" target="_blank">Improve this doc</a>
</p>

## Please Support YaCy


YaCy is libre software - licensed GPL-2+. Downloads are provided for free! Please consider to become 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 becoming a permanent supporter to ensure that YaCy can actively be developed!

### Become a YaCy Patron

Expand Down Expand Up @@ -37,7 +37,7 @@ YaCy is libre software - licensed GPL-2+. Downloads are provided for free! Pleas
Installation is very easy on any system. If it looks complex here it's just because we give directions in great detail.

### Compile YaCy yourself
You can download and build your own YaCy with these simple steps. This is probably the best and easiest ways for everyone who knwos how to use a command line interface. You need:
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:

* jdk-8 installed (Oracle Java 8 or OpenJDK 8)
* ant
Expand All @@ -62,15 +62,15 @@ To start YaCy from your compiled code, simply run:
* *IMPORTANT* Install Java 8 from [https://adoptopenjdk.net/](https://adoptopenjdk.net/) *first*.
* <a class="btn btn-success btn" href="https://download.yacy.net/yacy_v1.924_20201214_10042.exe" role="button">Download YaCy for Windows</a> from [https://download.yacy.net/yacy_v1.924_20201214_10042.exe](https://download.yacy.net/yacy_v1.924_20201214_10042.exe)
* Install YaCy by double-clicking the downloaded installer.
* When the message "Windows protected your PC (in Windows 10) appears, klick "More info", then "Run anyway". When asked "Do you want to allow this app from an unknown publisher to make changes to your device", klick "yes".
* When the message "Windows protected your PC (in Windows 10) appears, click "More info", then "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, klick "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){: width="400"}
* YaCy is then running on port 8090 on your machine. Open [http://localhost:8090](http://localhost:8090) in your web-browser.


### YaCy for Linux and other OS
### YaCy for Linux
You must install Java 8 on your computer if you don't have it already, and start the YaCy start shell script.
YaCy can run under a normal user account, no root rights are needed if Java 8 is already installed.

Expand Down Expand Up @@ -102,7 +102,7 @@ cd yacy
./startYACY.sh
```

* 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.
* Headless operation can be achieved by setting a password on the host console with `bin/passwd.sh <password>`.

Expand All @@ -113,12 +113,12 @@ cd yacy
* <a class="btn btn-success btn" href="https://download.yacy.net/yacy_v1.924_20201214_10042.dmg" role="button">Download YaCy for MacOS</a> from [https://download.yacy.net/yacy_v1.924_20201214_10042.dmg](https://download.yacy.net/yacy_v1.924_20201214_10042.dmg)
* Double-click the downloaded `.dmg`-file and copy the YaCy app out of the mounted drive into your "Application" folder.
* To run YaCy, just double-click the YaCy app icon in your "Application" folder.
* 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. Open [http://localhost:8090](http://localhost:8090) in your web browser.


### Docker ###

Running YaCy in docker is easy. If you don't hava docker installed, get it from [https://docs.docker.com/get-docker/](https://docs.docker.com/get-docker/) (for Mac, 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.
Running YaCy in Docker is easy. If you don't have Docker installed, get it from [https://docs.docker.com/get-docker/](https://docs.docker.com/get-docker/) (for Mac, 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.

The Official YaCy Images are hosted on Dockerhub at [https://hub.docker.com/r/yacy/yacy_search_server](https://hub.docker.com/r/yacy/yacy_search_server)

Expand Down Expand Up @@ -155,7 +155,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 @@ -175,7 +175,7 @@ docker start yacy_search_server
### 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
4 changes: 2 additions & 2 deletions docs/index.md
View file
Open in desktop
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">
<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">
<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/operation/headless.md
View file
Open in desktop
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.