Skip to content

Latest commit

 

History

History
87 lines (60 loc) · 3.41 KB

README.md

File metadata and controls

87 lines (60 loc) · 3.41 KB
Raw

Factotum Server

Release License

Overview

Job server as a web service. Enables the scheduling and concurrent execution of Factotum jobs. See the user guide for further information on getting up and running.

User quickstart

Assuming you're running 64 bit Linux:

$ wget https://github.com/snowplow/factotum-server/releases/download/0.3.0/factotum_server_0.3.0_linux_x86_64.zip
$ unzip factotum_server_0.3.0_linux_x86_64.zip
$ ./factotum-server --help

Factotum needs to be available locally. You can then run Factotum Server with preset defaults and the Factotum path specified in the following way:

$ ./factotum-server --factotum-bin=<PATH>

If Factotum is not already available:

$ wget https://github.com/snowplow/factotum/releases/download/0.6.0/factotum_0.6.0_linux_x86_64.zip
$ unzip factotum_0.6.0_linux_x86_64.zip
$ wget https://raw.githubusercontent.com/snowplow/factotum/master/samples/echo.factfile

These commands will download the 0.6.0 Factotum release, unzip it in your current working directory, and download a sample job for you to run.

Consul is an operational dependency - please see HashiCorp's getting started guide for Consul.

See the wiki for further guides and information.

Developer quickstart

Factotum Server is written in Rust.

Using Vagrant

  • Clone this repository - git clone git@github.com:snowplow/factotum-server.git
  • cd factotum-server
  • Set up a Vagrant box and ssh into it - vagrant up && vagrant ssh
    • This will take a few minutes
  • cd /vagrant
  • Compile and run a demo - cargo run -- --factotum-bin=/vagrant/factotum
    • Note: You will need to have downloaded the Factotum binary to the path above

Using stable Rust without Vagrant

  • Install Rust
    • on Linux/Mac - curl -sSf https://static.rust-lang.org/rustup.sh | sh
  • Clone this repository - git clone git@github.com:snowplow/factotum-server.git
  • cd factotum-server
  • Compile and run the server - cargo run -- --factotum-bin=/vagrant/factotum
    • Note: You will need to have downloaded the Factotum binary to the path above

Copyright and license

Factotum Server is copyright 2017-2021 Snowplow Analytics Ltd.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this software except in compliance with the License.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.