Skip to content

Commit 40d3516

Browse files
committed
solved conflicts for merging #6, transfered typo-fixes
1 parent a5328a3 commit 40d3516

File tree

4 files changed

+27
-21
lines changed

4 files changed

+27
-21
lines changed

docs/demonstration_tutorial_screenshot.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ We have screenshots, tutorial movies, and a live demonstration. If you want to j
1010

1111
### Search Results
1212

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

1616
Search result pages can be configured:
@@ -27,7 +27,7 @@ Search result ranking can be configured:
2727

2828
### Crawling
2929

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

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

4242
### Data Analysis
4343

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.
4545
To visualize that data about itself and the data it harvested from the internet, there are a lot of
4646
dashboards and monitoring features.
4747

@@ -51,7 +51,8 @@ The status page which informs about the current activities of your YaCy instance
5151
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:
5252
![YaCy Search Engine Host Browser](img/screenshot_host_browser.png)
5353

54-
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:
5556
![YaCy Search Engine Web Structure](img/screenshot_web_structure.png)
5657

5758
### Configuration
@@ -61,7 +62,10 @@ YaCy can be configured in every detail using the web interface. You can use a co
6162
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:
6263
![YaCy Search Engine Basic Configuration for Use Case: Peer-to-Peer, Portal, Intranet](img/screenshot_use_case_configuration.png)
6364

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!
6569
![YaCy Search Engine Performance Setting](img/screenshot_performance_settings.png)
6670

6771

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

8286
## Tutorial Movies
8387

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

8690
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!
8791

@@ -129,7 +133,7 @@ Instead of Java 7 now please install Java 11 (or higher)
129133
<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;">
130134
</div>
131135

132-
### Demo: Location Search with YaCy and Opensteetmap and Geonames
136+
### Demo: Location Search with YaCy and Openstreetmap and Geonames
133137
<div id="video07">
134138
<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;">
135139
</div>

docs/download_installation.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Because YaCy requires Java, first download and install Java (>= Java 11) from [h
1616
### With Docker
1717

1818
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.
2020

2121

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

4848
* 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`.
5252
* To run YaCy, double-click the YaCy app icon (which may be on your desktop).
5353
* Whenever the following dialog appears click `allow private networks` and `allow access`
5454
![Windows Java Security Setting](img/win_java_security_dialog.png)
55-
* YaCy is then running on port 8090 on your machine. Open [http://localhost:8090](http://localhost:8090) in your web-browser.
55+
* YaCy is then running on port 8090 on your machine. Open [http://localhost:8090](http://localhost:8090) in your web browser.
5656

5757

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

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

@@ -132,7 +132,7 @@ For example: the default peer name can be set with `network.unit.agent` in `yacy
132132
```
133133
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
134134
```
135-
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.
136136

137137
#### Backup and restore of DATA folder
138138
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.
154154

155155
When all works,
156156

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 web browser.
158158
* 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`.
159159

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

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

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

177178
You need:
178179

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

204205
```
205-
# optional: for a quick and easy installation of Kubernetes, run minikube
206+
# optional: for quick and easy installation of Kubernetes, run minikube
206207
minikube start
207208
minikube dashboard
208209
@@ -234,7 +235,8 @@ config set-context --current --namespace=default
234235

235236
# Please Support YaCy
236237

237-
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!
238240

239241
## Become a YaCy Patron
240242

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,12 @@ There are these three use cases you can choose from:
2828
<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;">
2929
<h2>Your Search Portal</h2>
3030
<img src="img/usecase_webportal.png" alt="YaCy Use Case: Web Portal">
31-
<p>Your YaCy installation is independent from other peers. Define your own web index and starting your own web crawl.</p>
31+
<p>Your YaCy installation is independent from other peers. Define your own web index and start your own web crawl.</p>
3232
</div>
3333
<div id="mode-intranet" class="col-md-4" style="background-color:#4E5D6C; padding-left:15px; padding-right:15px; position:relative; left:15px;">
3434
<h2>Intranet Search</h2>
3535
<img src="img/usecase_intranet.png" alt="YaCy Use Case: Intranet">
36-
<p>Create a search portal for your intranet or web pages or your (shared) file system.</p><br/>
36+
<p>Create a search portal for your intranet, web pages or your (shared) file system.</p><br/>
3737
</div>
3838
</div>
3939
</div>

docs/installation/headless.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,4 +49,4 @@ The password is stored in hashed form in the file <yacy-home>DATA/SETTINGS/yacy.
4949
* remove property adminAccount
5050
* set property serverAccount to <account>:<password>, i.e. serverAccount=admin:mysecretpassword
5151

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

0 commit comments

Comments
 (0)