Coder Social home page Coder Social logo

papyrus's Introduction

papyrus

A Jenkins based API & Toolchain.

How to use

First off, papyrus is only compatible with the linux platform.

Requirements

To install papyrus, you will need to have the following:

Installation

Once you have installed the required dependencies, you must clone the repository, this can be done with the command:

git clone https://github.com/PurpurMC/papyrus

Then cd into the directory and run the following command:

./build.sh

The output files of this command will be in the out directory.

To install the CLI, cd into the out directory and copy the papyrus binary to the /usr/local/bin directory.

To make sure papyrus is working, you can test the CLI with the papyrus command.

Then copy the rest of the files in the out directory to a location of your choice (this will be the location of the webserver).

Setup

To set up papyrus you will want to run sudo papyrus setup. This will create the /etc/papyrus.json file and the /srv/papyrus directory.

You must make sure that the user who will run the CLI has write permissions to the /srv/papyrus directory.

You will want to configure aspects of papyrus, so feel free to explore the config file. Everything is pretty self-explanatory.

To run the webserver, use the ./papyrus web command in the location where your webserver is. It is important you run this command from the local binary, not the global one.

Using the CLI

To add a new build to the CLI, you can use the papyrus add command.

The command syntax is: papyrus add [project] [version] [build] [file-path].

  • The project is the name of the project you want to add.
  • The version is the version of the project you want to add.
  • The build is the build number of the project you want to add.
  • The file-path is the path to the file you want to add (this part replaces the {file} in jenkins_file_path).

An example of the command is:

papyrus add purpur 1.18 1429 build/libs/purpur.jar

papyrus's People

Contributors

encode42 avatar theomega24 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.