https://github.com/calavera/trinidad_sandbox_extension

Extension to allow manage the applications deployed on Trinidad, ala Tomcat manager but built with Sinatra
https://github.com/calavera/trinidad_sandbox_extension

Last synced: about 2 months ago
JSON representation

Extension to allow manage the applications deployed on Trinidad, ala Tomcat manager but built with Sinatra

• Host: GitHub
• URL: https://github.com/calavera/trinidad_sandbox_extension
• Owner: calavera
• License: mit
• Created: 2010-04-23T15:42:54.000Z (over 14 years ago)
• Default Branch: master
• Last Pushed: 2011-03-27T23:56:18.000Z (almost 14 years ago)
• Last Synced: 2024-04-24T18:55:04.328Z (8 months ago)
• Language: Ruby
• Homepage: http://github.com/calavera/trinidad_sandbox_extension
• Size: 6.64 MB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README
  • Changelog: History.txt
  • License: LICENSE

Awesome Lists containing this project

README

        
Trinidad sandbox extension

======

# DESCRIPTION

Trinidad's management console and REST api.

This extension adds a management console to a Trinidad's instance moreover a rest api to access the applications running on top of it.

# INSTALL

jruby -S gem install trinidad_sandbox_extension

# CONFIGURATION

The extension has to be added within the section "extensions" into the Trinidad's configuration file:

---

  extensions:

    sandbox:

This extension is also a Sinatra web application running on top of Trinidad, so any application configuration parameter is also valid here.

For instance, we can modify the context path where is running the console:

---

  extensions:

    sandbox:

      context_path: management # by default the context path is sandbox

It also supports basic authentication, we'll have to specify the username and password within our section:

---

  extensions:

    sandbox:

      username: manager

      password: XXXXXXX

We can also use the console in readonly mode, so users can see the applications deployed but they cannot deploy new ones or modify them:

--- 

  extensions:

    sandbox:

      readonly: true

# FEATURES

The console as well as the REST api allow to list all the applications managed by that Trinidad's instance and start/stop them.

By security reasons the sandbox application is not listed nor can be stopped.

# GIT DEPLOYMENT

The sandbox console also allows to deploy new applications into Trinidad via Git. By default it uses ssh keys to access to the repository with the user `git`.

We can also use git hooks to deploy applications via a POST-Receive callback. 

In this case we use a token for authentication that must be set in the configuration, then we'll use an url like we show bellow in our hook:

---

  extensions:

    sandbox:

      deploy_token: ULTRA_SECRET_TOKEN

POST-Receive url: http://host/sandbox/deploy?deploy_token=ULTRA_SECRET_TOKEN

If we want to let users to deploy applications in public git repositories we can also disable the ssh authentication with the option `git_ssh`:

---

  extensions:

    sandbox:

      git_ssh: false

# TODO

This can be the starting point to a real management console, we could modify application parameters, show statistics...

Any improvement or redesign in the UI is welcome.