Skip to content

Latest commit

 

History

History
85 lines (51 loc) · 3.03 KB

README.md

File metadata and controls

85 lines (51 loc) · 3.03 KB
Raw

skynet

version api rustc license

Skynet is a service integration and management system, specially optimized for personal and home-lab use. With plugin support, you can easily embed whatever software you want to satisfy your need.

Security is considered as TOP priority in Skynet, we will not consider features that conflict with our security policy. If you find vulnerabilities, please report ASAP.

Quick start

Run in docker

We offer pre-built x86_64 and aarch64 docker images.

  1. Copy docker-compose.yml and conf.yml to your folder.
  2. docker-compose up
  3. Visit localhost:8080.

Run natively

We do not recommend this method, use at your own risk!

You can download pre-built libraries in our release page.

We offer linux-{x86_64,i686,aarch64}, darwin-{x86_64,aarch64} and windows-x86_64 binaries. You might build from source if your platform is not included.

Due to some bugs, SQLite backend may lead to load error in plugins currently.

  1. Download the release and extract.
  2. Install postgresql on your machine.
  3. (Optional) Install redis on your machine.
  4. vim conf.yml to modify your config.
  5. ./skynet check to verify your config.
  6. ./skynet run to start up the server.
  7. Visit localhost:8080.

Build from source

make build_release
make output BUILD_TYPE=release
make static

You are ready to go with files in bin :)

Create initial user

You must use the command line to initialize your root user:

skynet user init

Like linux, root user can ignore all built-in privilege checkers. Remember your initial randomized password, you can change it after login.

You may add more users in the web UI or use the command line for batch add:

skynet user add <USERNAME>

Note that no permission is allowed for these users.

Plugins

You can find plugins in our organization repositories or other user shares.

Use our script to download all official plugins:

./get_offical_plugins.sh

!!Please note that all plugins have the same privilege as skynet, use trusted plugins ONLY!!

In other words, run untrusted plugin = RCE

Develop

See develop note.

FAQ

How to trace logs?

Skynet provides pretty formatted or JSON formatted logs. You can get WARN and ERROR logs from stderr and others from stdout. Execute skynet run -h for more details. We only guarantee the order of printed logs. Please do not rely on notifications in database (see below).

Why do timestamps of notifications in database differ from those in console?

To avoid database deadlock and performance issues, notifications are written to database asynchronously. We do not guarantee the order and success of notifications.