arth
/
quartz
1
1
Fork 1
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity
Backend for Arth Panel, a self-hostable minecraft server panel. Made with Node.
186 Commits
3 Branches
0 Tags
32 MiB
JavaScript 94.8%
HTML 4.6%
Dockerfile 0.6%
 
 
 
Go to file
diamonc 486b5517a4 beta-1.2 2023-04-02 20:56:54 -05:00
routes beta-1.2 2023-04-02 20:56:54 -05:00
scripts beta-1.2 2023-04-02 20:56:54 -05:00
servers/template beta-1.2 2023-04-02 20:56:54 -05:00
stores beta-1.2 2023-04-02 20:56:54 -05:00
.gitignore beta-1.1 2023-02-14 17:29:39 -06:00
Dockerfile forwarding minecraft ports 2022-12-18 09:25:19 -06:00
LICENSE Create LICENSE 2022-09-28 19:01:23 -05:00
README.md beta-1.2 2023-04-02 20:56:54 -05:00
index.html updated wiki link 2023-01-07 16:57:25 -06:00
package-lock.json beta-1.2 2023-04-02 20:56:54 -05:00
package.json beta-1.2 2023-04-02 20:56:54 -05:00
pnpm-lock.yaml installed pnpm import, re-seperated terminal files 2022-10-14 18:05:36 -05:00
run.js beta-1.2 2023-04-02 20:56:54 -05:00
serverjars.properties added server state change, java app handler, mc template 2022-10-11 18:08:12 -05:00
utils.js formatted with prettier, cleaned up dockerfile comments 2022-10-11 16:45:54 -05:00

README.md

Get at Docker Hub

Warnings:

  • Arth Panel is in beta and should not be used in production yet.
  • There are several issues with the docker image currently, and we recommend running quartz directly for now.

Documentation can be found here

Quartz

Quartz is a backend for Arth Panel, a lightweight self-hosted Minecraft server panel. Quartz is made with Node and Express.

How to run without docker

  1. Grab the source code with git clone https://codeberg.org/arth/quartz
  2. Install the packages with npm i
  3. Run with node run

How to configure

  • stores/settings.json is where you can modify settings.
  • stores/secrets.json is where you can enter your stripe key if you want payments enabled.

How to run with docker (Unsupported)

  1. Download the image from docker hub with the command sudo docker pull arthmc/quartz:latest
  2. Run the image with sudo docker run -p 4000:4000 arthmc/quartz:latest. To change the port, replace the first 4000 with the port number you want.

Dependencies

  • Arth Uses the curl command to download plugins and the convert command to downscale images. If you want these functionalities, you'll need to install those commands.

Contributing

To run a dev server, follow the instructions in "how to run without docker"

Contributing Guidelines

  • Please format your code with Prettier VSCode extension or an alternative that achieves the same results.

Check out our frontend's progress

Why Arth Panel?

The main difference between an alternative like pufferpanel or pterodactyl is that it's meant to work in a way so that if an issue were to occur, you could easily just SSH into the machine and run the jar directly in a folder, so you know that your server's uptime is not dependant on a panel someone else made working flawlessly.

To-do list

✅ Basic file data storage that stores details about servers.
✅ Basic API that provides details about servers to frontend.
✅ Ability to run Minecraft servers with specified versions and softwares
✅ Basic communication with frontend for terminal
✅ Consistent routes
✅ Locking a customer's assets behing a password ❓ Protecting customer assets with end-to-end encryption