https://github.com/tuna/registr

https://github.com/tuna/registr

Last synced: 5 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/tuna/registr
• Owner: tuna
• License: gpl-3.0
• Created: 2014-05-14T12:47:21.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2020-09-16T06:46:17.000Z (about 4 years ago)
• Last Synced: 2024-08-02T01:27:35.963Z (3 months ago)
• Language: JavaScript
• Size: 1.09 MB
• Stars: 6
• Watchers: 19
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Registr

A "simple" web-based registering tool.

## Installation

### With Docker

clone this git repo and build docker image:

```

~> sudo docker build -t tuna/registr .

```

That's all:

```

~> sudo docker images | grep registr

```

### Without Docker

See contents of `Dockerfiles` please.

## Usage

Create an empty sqlite database:

```

~> touch /path/to/registration.db

```

Then create a container with following command:

```

~> sudo docker run -it --rm --name=registr \

        -p 80:8000 \

        -v /path/to/registration.db:/data/registr.db \

        -e FLASK_BASIC_AUTH_USERNAME=username \

        -e FLASK_BASIC_AUTH_PASSWORD=password \

        -e FLASK_SECRET_KEY='A very long secret key' \

        -e "FLASK_SQLALCHEMY_DATABASE_URI=sqlite:////data/registr.db" \

        -e FLASK_BABEL_DEFAULT_LOCALE=zh_Hans_CN \

        tuna/registr

```

Options:

* `FLASK_BASIC_AUTH_USERNAME`: username for admin page

* `FLASK_BASIC_AUTH_PASSWORD`: password for admin page

* `FLASK_SECRET_KEY`: secret key used by flask in client-end session, keep it safe and unpredictable

* `FLASK_BABEL_DEFAULT_LOCALE`: default locale

## Add New Languages

Currently, we support following locales:

* zh\_Hans\_CN

* de\_DE

* ja\_JP

* nl\_NL

* en\_US

If new one is required, install dependencies in `requirements.txt` and run:

```

~> ./i18n init 

```