Skip to content

Commit

Permalink
transfered more oldwiki pages + translated net-definition
Browse files Browse the repository at this point in the history
  • Loading branch information
okybaca committed Mar 10, 2024
1 parent 54aab65 commit 357de59
Show file tree
Hide file tree
Showing 10 changed files with 1,245 additions and 19 deletions.
18 changes: 12 additions & 6 deletions docs/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,12 @@
* [FAQ](faq.md) - Frequently asked questions
* [Readme](https://github.com/yacy/yacy_search_server/blob/master/README.md) - at github.com


## Operation
## Installation
* [Headless - YaCy on a Remote Server](installation/headless.md)
* [Shrink Debian by removing all graphical features to turn it into a headless server](installation/shrink.md)
* [Set a static IP to a debian server](installation/staticip.md)

## Operation
* [Setting the ranking rules](operation/ranking.md)
* [YaCy config settings](operation/yacy_conf.md)

Expand All @@ -22,6 +23,10 @@
## Converted from old-wiki
may be outdated, you can help the community by checking and [improving](contribute.md) the pages

### Basics
* [Use cases](use_cases.md)
* [Features](features.md)

### Installation
* [System Requirements](installation/requirements.md)
* [Arch Install Guide](installation/archinstall.md)
Expand All @@ -34,12 +39,13 @@ may be outdated, you can help the community by checking and [improving](contribu
* [Set up Raspberry Pi with YaCy](installation/raspberry_pi.md)

### Operation
* [YaCy and Tor](operation/yacy-tor.md)
* [Index Creation - Crawl Start](operation/crawlstart_p.md)
* [Autoupdate](operation/autoupdate.md)
* [Portforwarding](operation/portforwarding.md)
* [Using the YaCy Front-End over HTTPS](operation/yacyoverhttps.md)



* [Performance Tuning](operation/performance.md)
* [YaCy and Tor](operation/yacy-tor.md)
* [Network Definition](operation/network-definition.md)

## Old and obsolete
The original YaCy wiki is closed now (no new registration or editing) and
Expand Down
118 changes: 118 additions & 0 deletions docs/features.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
# Features

Main technical features :

- P2P network architecture
- Cross-platform : can work on any operating system which can run a
[JVM](https://en.wikipedia.org/wiki/Java_virtual_machine)
- Parsing capabilities :
- TXT clear text
- CSV tabular data
- RTF rich text
- XML structured data
- HTML web documents
- RSS, RDF, Atom Newsfeeds
- MS Office Excel, Word, Powerpoint
- MS Visio diagrams
- ODF OpenDocument
- PDF Portable Document
- PS Postscript
- SWF Adobe Flash
- VCard Electronic Business Card
- Archives : 7zip, zip, bz2, tbz, tbz2, tar.gz, rpm, jar, apk
- Images : png, jpg, gif, svg, ico, bmp, tif, psd
- CAD Drawings : dwg
- MM FreeMind mind maps
- Audio : mp3, ogg, oga, m4a, m4p, flac, wma, sid
- Torrent torrent metadata
- OpenSearch interface
- Load balancing
- Automated index redundancy distribution
- Direct import of Fremd-DB (Surrogate Harvester API)
- Automatic indexing through a proxy filter
- Embedded web server
- Internal domain names ending in .yacy
- P2P bootstrap from central seed lists
- Spell check
- Filter expression. e.g. : filetype:pdf
- UTF-8 encoding

## Technologies

Below are the main technologies used in the project :

- Java 11
- [XHTML](https://www.w3.org/TR/2002/REC-xhtml1-20020801/),
[CSS](https://www.w3.org/Style/CSS/),
[JavaScript](https://en.wikipedia.org/wiki/JavaScript)
- [JSON](http://json.org/)
- [Dublin Core](http://dublincore.org/)
- External components :
- [Apache Commons](https://commons.apache.org/) Toolkit
- [Apache HttpComponents](https://hc.apache.org/)
- [Apache Jakarta Oro](http://jakarta.apache.org/oro/) RegExp
- [Apache POI](http://poi.apache.org/) API for Microsoft Documents
- [Apache James Mime4j](https://james.apache.org/mime4j/)
- [Apache Lucene](https://lucene.apache.org/)
- [Apache Solr](http://lucene.apache.org/solr/)
- [Apache PDFBox and FontBox](http://pdfbox.apache.org/)
- [Apache Xerces](http://xerces.apache.org/xerces-j/) XML Parser
- [Apache XML APIs](http://xml.apache.org/commons/)
- [Bouncy Castle](http://www.bouncycastle.org/java.html) Crypto
APIs : Provider, Mail
- [GlassFish](https://glassfish.dev.java.net) Servlets
- [Guava](https://github.com/google/guava)
- [ICU](http://site.icu-project.org/) International Components for
Unicode
- [J7Zip](http://p7zip.sourceforge.net/)
- [Java CIFS](http://jcifs.samba.org) Client Library
- [Jazzy](https://sourceforge.net/projects/jazzy/) Spelling API
- [Jaudiotagger](http://www.jthink.net/jaudiotagger/)
- [JSch](http://www.jcraft.com/jsch/) Java Secure Channel
- [JDBC](http://www.oracle.com/technetwork/java/javase/jdbc/index.html)
- [Jetty](http://www.eclipse.org/jetty/) Web server
- [jQuery](https://jquery.com/) JavaScript library
- [JSONIC](http://jsonic.osdn.jp/) json encoder/decoder
- [json-simple](https://github.com/fangyidong/json-simple) toolkit
- [jsoup](http://jsoup.org/) Java HTML Parser
- [language-detection](https://github.com/shuyo/language-detection)
library
- [metadata-extractor
API](http://www.drewnoakes.com/drewnoakes.com/code/exif/)
- [Mozilla charset
detector](http://sourceforge.net/projects/jchardet/)
- [Noggit](https://github.com/yonik/noggit) JSON parser
- [Restlet
Framework](https://restlet.com/projects/restlet-framework/)
- [SLF4J](http://www.slf4j.org/) Simple Logging Facade for Java
- [Spatial4j](https://www.locationtech.org/projects/technology.spatial4j)
spatial/geospatial library
- [Stax2 API](https://github.com/FasterXML/stax2-api)
- [TwelveMonkeys ImageIO
plugins](https://github.com/haraldk/TwelveMonkeys) : BMP, TIFF
- [Giant Java Tree](http://www.gjt.org/) TAR Package
- [WebCat](http://webcat.sourceforge.net) SWF Package
- [Weupnp](http://bitletorg.github.io/weupnp/) tiny UPnP client
- [Woodstox](http://wiki.fasterxml.com/WoodstoxHome) XML processor
- [XMP](http://www.adobe.com/devnet/xmp.html) Adobe's Extensible
Metadata Platform
- Build and tests utils
- [Apache Ant](http://ant.apache.org/) Building Environment
- [JRPM](http://jrpm.sourceforge.net/)
- [JUnit](http://jrpm.sourceforge.net/) testing framework

# Issues

- Stability
- Performance
- Languages support
- Very simple stemming



_Converted from
<http://wiki.yacy.de/index.php?title=En:Features>, may be outdated_




6 changes: 3 additions & 3 deletions docs/installation/requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,16 @@ environment on your system yet, you must install it before installing
YaCy. GNU/Linux distributions may include, e.g. a free one called
[OpenJDK](http://openjdk.java.net/install/). Otherwise, Java is
available from the [Sun website](http://java.com/en/download/index.jsp).
The minimum Java version you need for YaCy is Java 7 — which might
The minimum Java version you need for YaCy is Java 11 — which might
change in the future.

Note that Apache Solr beeing a YaCy core component, it is a good idea to
follow also Solr recommendations. For example, YaCy 1.82 includes Solr
4.10.3 : Java 1.7.0\_u55 or later is recommanded (see [Solr System
4.10.3 : Java 1.7.0_u55 or later is recommended (see [Solr System
Requirements](https://lucene.apache.org/solr/4_10_3/SYSTEM_REQUIREMENTS.html))

Because of this — and the fact that the newer Java version is more
powerful than the old one — you should chose Java 7 right from the
powerful than the old one — you should chose Java 11 right from the
start. If the only thing you want to do is just run Java programs you
can make do with the [JRE (Java Runtime
Environment)](https://en.wikipedia.org/wiki/Java_Runtime_Environment). If you want to develop
Expand Down
82 changes: 82 additions & 0 deletions docs/operation/autoupdate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
# Autoupdate

## Using Autoupdate

Just go to this page: <http://localhost:8090/ConfigUpdate_p.html>

You can either manually choose a release from the update locations and
update or enable the autoupdate feature. The autoupdate regularly
(configure the interval) checks the update locations. You can choose
between main (stable snapshot-releases ~ every 2 months) or the current
dev releases. The dev releases ending on 123 are often more experimental
than the others, so they are blacklisted by default.

## Setup your own update location

An updatelocation is just a HTML-Page with links to yacy-tarballs
conforming to the version-scheme. The updatelocation is configured per
network in the network-definition (for example
defaults/yacy.network.freeworld.unit):

network.unit.update.location0 = http://your.domain.tld/yacyreleases/

## Setup signatures

To be sure, YaCy really downloads the tarballs, the updatelocation admin
uploaded, you should provide signatures for your releases. DNS-spoofing,
man-in-in-the-middle-attacks or attacks on the webserver are not that
difficult.

### Generate a private and a public key

Configure the location where to put the private key with the property
*privateKeyFile* in *build.properties* . Then run

ant genkey

The private key will be created at the specified location. The public
key has the extension *.pub*.


**Note:** The default value for privateKeyFile is "private.key" and the
private and public key are directly created in the yacy folder



### Put public key in network-definition

The network definition file should look like this:

network.unit.update.location0 = http://your.domain.tld/yacyreleases/
network.unit.update.location0.key = MIIBuDCCASwGQeEwx7V...(very long)...bukaPtQxr2p9y1QNZFauihmu4ak4AyT

Now, YaCy will try to download the signature and check it. So provide
*.sig*-files\!



**Note:** The default network definitions file is located in
`defaults/yacy.network.freeworld.unit.`

But the values can be changed during runtime as well here:
<http://localhost:8090/ConfigProperties_p.html>




### Generate a distribution tarball with signature

Just run:

ant clean dist sign

You'll find the tarball and a .sig-file in the RELEASE-directory. Put
them on the updatelocation


_Converted from
<https://wiki.yacy.net/index.php?title=En:AutoUpdate>, may be outdated_




Loading

0 comments on commit 357de59

Please sign in to comment.