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.

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

Conversation

dsaw
Copy link

@dsaw dsaw commented Dec 17, 2021

No description provided.

@genesisrefinedllc
Copy link

Corrections:

  1. "plattform" should be "platform"
  2. "Coder Container" should likely be "Docker Container" (assuming this refers to a Docker container)
  3. "hava" should be "have"
  4. "https://www.docker.com/blog/getting-started-with-docker-for-arm-on-linux/" should be a markdown link: [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/)
  5. "59c0cb0f3.exe" is missing from the Windows download link. It should be: https://download.yacy.net/yacy_v1.930_202405130205_59c0cb0f3.exe
  6. "59c0cb0f3.dmg" is missing from the macOS download link. It should be: https://download.yacy.net/yacy_v1.930_202405130205_59c0cb0f3.dmg
  7. "klick" should be "click"
  8. "decompressed folder" should be "decompressed directory" or "extracted directory"
  9. "startYACY.sh" should be in backticks: `./startYACY.sh` in the example code blocks.
  10. "Macintosh application does not store it's" should be "Macintosh application does not store its"
  11. "Any OS with Java >= 11" should be a heading, likely "Installing on Any OS with Java >= 11"
  12. "Mac, Windows and Linux" should be "macOS, Windows, and Linux"
  13. "i.e." should be followed by a comma.
  14. "admin:yacy" should be in backticks: `admin:yacy`
  15. "yacy_search_server_data" should be in backticks: `yacy_search_server_data` in the docker commands.
  16. "Howwever" should be "However"
  17. "Headless operation can be achieved by setting a password on the host console with bin/passwd.sh " should have backticks around bin/passwd.sh: "Headless operation can be achieved by setting a password on the host console with `bin/passwd.sh` "
  18. "Build by your own" should be "Build Your Own" or "Build YaCy Yourself"
  19. The Kubernetes section has some inconsistencies in formatting and could be improved for readability. Specifically, the commands should be in code blocks or backticks, and the comments could be more concise.
  20. "libre software" should be "free software" or "open-source software"
  21. "Downloads are provided for free!" is redundant, should be removed.

Corrected Text:

Download - YaCy

YaCy is available as packages for Linux, Windows, macOS, and also as a Docker Image. You can also install YaCy on any other operating system either by compiling it yourself or using a tarball. YaCy needs Java 11; Temurin 11 is recommended.

Quick Install

Prerequisites

You either need Java or Docker.

On Linux, Windows, and macOS

Because YaCy requires Java, first download and install Java (>= Java 11) from https://adoptium.net/. On Linux, use your supported platform like dnf or apt-get.

With Docker

If you run YaCy with Docker, you don't need to install Java on your system; it's all contained in the Docker Container. If you don't have Docker installed, get it from 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/ to install Docker on Raspberry Pi or any other ARM-based devices.

Download

From https://download.yacy.net/yacy_v1.930_202405130205_59c0cb0f3.exe
From https://download.yacy.net/yacy_v1.930_202405130205_59c0cb0f3.tar.gz
From https://download.yacy.net/yacy_v1.930_202405130205_59c0cb0f3.dmg

For Linux, from https://release.yacy.net/

With Docker

The Official YaCy Images are hosted on Docker Hub at https://hub.docker.com/r/yacy/yacy_search_server

We provide amd64, arm64v8, and arm32v7 versions with the following tags:

  • amd64: yacy/yacy_search_server:latest
  • arm64v8: yacy/yacy_search_server:aarch64-latest
  • arm32v7: yacy/yacy_search_server:armv7-latest

Get the Source Code

The source code is inside the generic tarball. It is recommended you clone the Git repository at https://github.com/yacy/yacy_search_server.

Installation

On Windows

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

On Linux

YaCy can run under a normal user account; no root rights are needed.

  1. Unpack the tarball.
tar xfz yacy<VERSION>.tar.gz
  1. Run `./startYACY.sh` inside your extracted directory.
cd yacy<VERSION>
./startYACY.sh

Installing from start to finish would look something like this, depending on your distro:

sudo apt-get update
sudo dpkg --configure -a
sudo apt-get install -y openjdk-11-jre-headless
wget https://download.yacy.net/yacy_v1.930_202405130205_59c0cb0f3.tar.gz
tar xfz yacy_v1.930_202405130205_59c0cb0f3.tar.gz
cd yacy
./startYACY.sh

On macOS

  1. Double-click the downloaded .dmg file and copy the Yacy.app to the "Application" folder.
  2. To run YaCy, just double-click the YaCy app icon in your "Application" folder.

The Macintosh application does not store its index within the application folder (like the Linux version does); instead, the index is written to ~/Library/Application\ Support/net.yacy.YaCy/DATA/. If you want to migrate the YaCy index on Mac, you don't need to do anything; the new YaCy version simply uses the same location again.

Installing on Any OS with Java >= 11

Automatic development builds can be obtained from https://release.yacy.net/.

Docker

Running YaCy in Docker is easy. If you don't have Docker installed, get it from 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/ to install Docker on Raspberry Pi or any other ARM-based devices.

The Official YaCy Images are hosted on Docker Hub at https://hub.docker.com/r/yacy/yacy_search_server

We provide amd64, arm64v8, and arm32v7 versions with the following tags:

@okybaca
Copy link

okybaca commented Feb 10, 2025 via email

@Orbiter
Copy link
Member

Orbiter commented Feb 13, 2025

@genesisrefinedllc can you please resolve the conflicts to enable that we can pull this here or in a different pull request?

This was referenced Feb 13, 2025
@okybaca
Copy link

okybaca commented Feb 16, 2025

I did resolve the conflicts by hand in #44 and included the fixes by @genesisrefinedllc mentioned here.

@Orbiter
Copy link
Member

Orbiter commented Feb 16, 2025

ok thank you! So we can close this pull request?

@okybaca
Copy link

okybaca commented Feb 16, 2025 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants