Skip to content

p-mongodb/tenex

Repository files navigation

Tenex

Tenex is a mashup application built on top of Evergreen, Travis, Github and Jira APIs. Its goal is to increase developer productivity by presenting commonly needed data in an effective fashion, integrating the various services used during development and providing shortcuts for commonly used operations.

Features

See README.features.md for a detailed list.

Installation

Using Docker

Create a MongoDB container for persistence:

docker network create --driver bridge mongodb-net
docker run -d --name mongodb --network mongodb-net \
  -v /path/to/db:/data/db mongo:4.4

Create a configuration directory, /path/to/config. In this directory place the following files:

  • env: The file with most settings.
  • id_*: The SSH identity file(s).

The SSH identity is used for reading and writing private repositories in GitHub. To generate it, run:

ssh-keygen -t ed25519 -C tenex -f config/id_tenex

Run tenex as a Docker container:

docker run -p 8080:80 --network mongodb-net --rm \
  -v /path/to/config:/etc/tenex:ro pmongo/tenex

The application will be available at http://localhost:8080.

Local

Tenex uses MongoDB for persistence, Redis for background job storage and is implemented in Ruby, therefore you'll need reasonably recent versions of these dependencies installed. Then:

git clone https://github.com/p-mongo/tenex
cd tenex
bundle install
cp config/env.sample config/env

Configuration

Edit the env file in config directory, and fill out:

Note that the Github access token needs to have various scopes on it to access various bits of functionality, but Github api documentation does not specify which endpoints need which scopes. Checking the "repo" check box is sufficient to enable all tenex functionality.

Edit config/mongoid.yml and change the host, port and database used for MongoDB (note the MongoDB port specified by tenex is 27027, default MongoDB port is 27017).

Redis address is currently not configurable (the default 127.0.0.1:6379 is used).

Running

Using Docker

The Docker image of Tenex contains all needed dependencies, including a self-contained MongoDB installation. The simplest possible configuration provides the config file to the container and exposes port 80 to the host system, as follows:

docker run -itp 9000:80 -e DOTENV="`cat .env`" pmongo/tenex

This invocation will reset the database on each run.

In Production

puma .config.ru -b tcp://127.0.0.1:9393 -e production

Tenex presently does not perform authentication itself, therefore it should be reverse-proxied to by a web server that has authentication configured.

In Development

Local launch:

./script/server

This launches a self-reloading web server on port 9393.

In production, use your favorite web server to run .config.ru (note the leading dot).

Docker launch:

docker build -t pmongo/tenex . &&
  docker run -itp 9000:80 -e DOTENV="`cat .env`" pmongo/tenex

Building

Docker build & push:

docker build -t pmongo/tenex . && docker push pmongo/tenex

License

MIT

About

Developer productivity tool

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published