Artificial-Engineering/lycheejs-harvester

Name: lycheejs-harvester

Owner: Artificial Engineering

Description: :computer: HTTP/1.1 and WS13 compliant multiplexed multi-host multi-socket peer-synchronized server (built with lychee.js, auto-fertilized and auto-published by @humansneednotapply)

Created: 2015-06-12 07:08:22.0

Updated: 2017-04-09 13:44:43.0

Pushed: 2018-03-31 17:39:51.0

Homepage: https://lychee.js.org

Size: 27598

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

lychee.js Harvester

brought to you as libre software with joy and pride by Artificial Engineering.

Support our libre Bot Cloud via BTC 1CamMuvrFU1QAMebPoDsL3JrioVDoxezY2.

Overview

lycheejs-harvester is a fork of the upstream lychee.js Engine.

It is a portable, dead-simple and easy to use webserver.

It uses the /libraries/harvester library in order to build up a webserver. The harvester is a peer-cloud synchronized webserver that shares threats, improvements and updates among other instances across the interwebz.

It is automatically built and deployed to GitHub using the following lycheejs-fertilizer integration scripts:

• bin/build.sh builds the harvester
• bin/package.sh deploys everything to the releases section on GitHub.

The upstream project can be found in the lychee.js Engine repository or on the lychee.js Website repository available at https://lychee.js.org.

Features

As the lycheejs-harvester is built with the lychee.js Engine, the webserver can also be used on embedded and mobile devices.

Here's a quick feature list:

• Headless Webserver
• Portable Webserver
• Extendable Webserver (when used as a library)
• No additional requirements
• HTTP 1.1 compliant
• WS 13 compliant
• TCP fallback
• Multiplexed HTTP sockets
• Multipipelined HTTP sockets
• Multiple Instances
• Multiple Profiles
• On-the-fly Protocol Upgrades and Downgrades for NAT breaking
• Sandboxed Instances (debuggable with lycheejs-ranger)
• Serializable Instances (resumable on another device at a different time)
• Event-driven API
• Socket-driven API

Bundle Installation

The releases section offers pre-built bundles for multiple operating systems.

Installation and Build Process

The build process is integrated with the lycheejs-fertilizer toolchain. These are the steps to get everything to run and build properly:

Local development requires zero overhead, just start the lycheejs-harvester and use the existing toolchain.

opt/lycheejs;

is will clone the harvester repository correctly
clone --single-branch --branch master https://github.com/Artificial-University/lycheejs-harvester ./projects/lycheejs-harvester;

is will build and deploy the harvester automatically
eejs-fertilizer node/main /projects/lycheejs-harvester;

Usage

Use cd /path/to/project to serve the correct project folder. If the project folder is a lychee.js Library or Project, it will be automatically synchronized with the peer-cloud.

If you want to change the Harvester's behaviour, you can use the following flags:

• Use --host to bind the server to a specific host.
• Use --port to bind the server to a specific port. It is defaulted with 8080.
• Use --debug to activate debug mode with verbose debug messages.
• Use --sandbox to activate sandbox mode without software bots.

Example

is will serve the folder /var/www/my-project on artificial.engineering:1337

var/www/my-project;

eejs-harvester --host=artificial.engineering --port=1337;

License

lychee.js is (c) 2012-2016 Artificial-Engineering and released under MIT / Expat license. The projects and demos are licensed under CC0 (public domain) license. The runtimes are owned and copyrighted by their respective owners and may be shipped under a different license.

For further details take a look at the LICENSE.txt file.