Moonbase

Note: Moonbase currently has large functionality problems that prevent it from working properly. The SSS team is currently debating a complete rewrite.

Moonbase is a website management and deployment system, designed for Student Server Space. Moonbase is written in Ruby, and is designed for use on Ubuntu. Currently, Moonbase supports static and script-generated websites.

Usage

Moonbase is supported on Ubuntu and Mac OSX. As Moonbase is developed with Ruby, it requires Ruby to run.

To run one-time setup, run:

$ ./setup

Setup creates a few files, as well as a prompt to set an initial password.

To start the server, run:

$ ./start

By default, Moonbase runs on localhost:8001.

To regenerate the password, run:

$ ./key-gen.sh

Configuration

config.yml is the config file. The sample configuration file (config.sample.yml) will work without any modifications, and is created by the setup command. By default, it should look like this:

address:  localhost
port:     8001
root:     site
projects: site/projects
user-key: ./user/login.key
database: ./user/projects.yml

...

Line by line, here is the purpose of each setting in the configuration file:

1. address is the public IP address that Moonbase will attach too. Note: IPv6 may not work. Currently unable to test due to a budget of $0.
2. port is the port that Moonbase will listen to. Port 88 is standard for HTTP websites.
3. root is the path that Moonbase will look in for files to serve.
4. projects is the path where Moonbase will store all projects that it is currently serving.
5. user-key is the file that Moonbase expects to find a hashed password.
6. database is the file that Moonbase uses to store data about projects.

Moonbase also has a built-in HTTPS server. To configure, set https to true, and direct it to a valid key/certificate pair. As a development aid, a local certificate generation tool is included. Run it using ./gen-cert.sh and it should automatically generate a valid 4096 RSA key/cert pair. The configuration for this default pair is included in the sample configuration.

Contributing

If you would like to contribute to Moonbase, that would be awesome! Follow the usage instructions to set up a local copy on your machine, and start developing. After you've completed your changes, send us a pull request.

Credits

• @jacksarick - original creator
• @malsf21 - long-term maintainer
• @obrien66 - developer