You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/demonstration_tutorial_screenshot.md
+11-7Lines changed: 11 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ We have screenshots, tutorial movies, and a live demonstration. If you want to j
10
10
11
11
### Search Results
12
12
13
-
This is the search result page using peer-to-peer data:
13
+
This is the search results page using peer-to-peer data:
14
14

15
15
16
16
Search result pages can be configured:
@@ -27,7 +27,7 @@ Search result ranking can be configured:
27
27
28
28
### Crawling
29
29
30
-
Before search resuls can be provided, a web crawl must be done to harvest the required document corpus.
30
+
Before search results can be provided, a web crawl must be done to harvest the required document corpus.
31
31
32
32
There is a easy-to-use simple crawl start service which takes almost only the starting URL as input:
33
33

@@ -41,7 +41,7 @@ For more complex harvesting tasks, here is the Expert Crawl Start service:
41
41
42
42
### Data Analysis
43
43
44
-
A running YaCy instance has many management tasks runnning and it creates a lot of data.
44
+
A running YaCy instance has many management tasks running and it creates a lot of data.
45
45
To visualize that data about itself and the data it harvested from the internet, there are a lot of
46
46
dashboards and monitoring features.
47
47
@@ -51,7 +51,8 @@ The status page which informs about the current activities of your YaCy instance
51
51
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:
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:
54
+
While the host browser reveals the structure of documents within all of the single domains, the web
55
+
structure service shows how domains are linked to each other:
55
56

56
57
57
58
### Configuration
@@ -61,7 +62,10 @@ YaCy can be configured in every detail using the web interface. You can use a co
61
62
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:
62
63

63
64
64
-
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!
65
+
The main purpose of YaCy is to aquire a lot of data from the web and make
66
+
them searchable. Consequently, this uses a lot of disk space. We make the
67
+
resources which YaCy takes configurable with the following service. YaCy
68
+
loves to use more RAM if available, give it more RAM and it performs better!
@@ -81,7 +85,7 @@ Every connection that YaCy does, peer-to-peer or crawling, is monitored as well:
81
85
82
86
## Tutorial Movies
83
87
84
-
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.
88
+
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.
85
89
86
90
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!
87
91
@@ -129,7 +133,7 @@ Instead of Java 7 now please install Java 11 (or higher)
### Demo: Location Search with YaCy and Opensteetmap and Geonames
136
+
### Demo: Location Search with YaCy and Openstreetmap and Geonames
133
137
<divid="video07">
134
138
<imgsrc="../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;">
Copy file name to clipboardExpand all lines: docs/download_installation.md
+13-11Lines changed: 13 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ Because YaCy requires Java, first download and install Java (>= Java 11) from [h
16
16
### With Docker
17
17
18
18
If you run YaCy with Docker you don't need to install Java on your system, it's all contained in the Coder Container.
19
-
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.
19
+
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.
20
20
21
21
22
22
## Download
@@ -46,13 +46,13 @@ The source code is inside the generic tarball. It is recommended you clone the G
46
46
### On Windows
47
47
48
48
* Double-clicking the downloaded installer.
49
-
* When the message `Windows protected your PC` (in Windows 10) appears, klick`More info`->`Run anyway`.
50
-
* When asked `Do you want to allow this app from an unknown publisher to make changes to your device`, klick`yes`.
51
-
* Within the YaCy Installer, klick`Next`, `I Agree`, `Next`, `Install`, `Finish`.
49
+
* When the message `Windows protected your PC` (in Windows 10) appears, click`More info`->`Run anyway`.
50
+
* When asked `Do you want to allow this app from an unknown publisher to make changes to your device`, click`yes`.
51
+
* Within the YaCy Installer, click`Next`, `I Agree`, `Next`, `Install`, `Finish`.
52
52
* To run YaCy, double-click the YaCy app icon (which may be on your desktop).
53
53
* Whenever the following dialog appears click `allow private networks` and `allow access`
This can also be used to re-start a previously started image to overwrite the already stored configuration values.
135
+
This can also be used to restart a previously started image to overwrite the already stored configuration values.
136
136
137
137
#### Backup and restore of DATA folder
138
138
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
@@ -154,7 +154,7 @@ This will mount the data volume from the upgraded yacy instance.
154
154
155
155
When all works,
156
156
157
-
* YaCy is now running on port 8090 on your machine. Open [http://localhost:8090](http://localhost:8090) in your web-browser.
157
+
* YaCy is now running on port 8090 on your machine. Open [http://localhost:8090](http://localhost:8090) in your webbrowser.
158
158
* 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`.
159
159
160
160
You should always set a new admin password!
@@ -172,7 +172,8 @@ You should always set a new admin password!
172
172
173
173
Installation is very easy on any system. If it looks complex here it's just because we give directions in great detail.
174
174
175
-
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.
175
+
You can download and build your own YaCy with these simple steps. This is probably the best and easiest way for
176
+
anyone who knows how to use a command line interface.
176
177
177
178
You need:
178
179
@@ -202,7 +203,7 @@ The compiled tarball will then be in the `RELEASE` folder.
202
203
# Kubernetes
203
204
204
205
```
205
-
# optional: for a quick and easy installation of Kubernetes, run minikube
206
+
# optional: for quick and easy installation of Kubernetes, run minikube
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!
238
+
YaCy is libre software - licensed GPL-2+. Downloads are provided for free! Please consider
239
+
to become a permanent supporter to ensure that YaCy can actively be developed!
0 commit comments