Skip to content

Latest commit

 

History

History
108 lines (58 loc) · 2.83 KB

README.rdoc

File metadata and controls

108 lines (58 loc) · 2.83 KB
Raw

Gritano ↑

<img src=“https://badge.fury.io/rb/gritano.png” alt=“Gem Version” /> <img src=“https://travis-ci.org/igorbonadio/gritano.png” />

Gritano is the simplest way to configure a git server over ssh. You can create repositories and manage user access using this practical tool.

Requirements ↑

Install ↑

$ gem install gritano

Update ↑

0.x.x or 1.0.0 to 2.x.x ↑

Unfortunately, Gritano 2.x.x is not compatible with any version previous to 2.0.0.

Usage ↑

First of all you should create a git user who will be responsible for store and manipulate repositories. Lets suppose we are logged as this user.

All you need to do to set up Gritano is

$ gritano init && gritano db:migrate

After that you can add users:

$ gritano user:add igorbonadio

add administrator rights to this user:

$ gritano user:update igorbonadio --admin=true

add user’s public keys:

$ gritano user:key:add igorbonadio mykey < id_rsa.pub

create bare repositories:

$ gritano repo:add proj.git

and control access:

$ gritano repo:read:add proj.git igorbonadio

For more information, execute

$ gritano help

User Access ↑

Gritano 0.2.0 introduced a new feature that enables users to execute some simple commands via ssh:

$ ssh git@host.com username

$ ssh git@host.com repo:list

$ ssh git@host.com key:list

$ ssh git@host.com key:add mykey < id_rsa.pub

$ ssh git@host.com key:rm mykey

For more information, execute

$ ssh git@host.com help

Admin Access ↑

Starting from Gritano 0.3.0, administrators can execute commands via ssh:

$ ssh git@host.com admin user:add username

$ ssh git@host.com admin user:rm username

$ ssh git@host.com admin user:key:add username keyname < key.pub

$ ssh git@host.com admin user:key:rm username keyname

$ ssh git@host.com admin repo:add reponame.git

$ ssh git@host.com admin repo:rm reponame.git

$ ssh git@host.com admin repo:list

For more Information ↑

gritano.org

Contributing to Gritano ↑

  • Check out the latest master to make sure the feature hasn’t been implemented or the bug hasn’t been fixed yet.

  • Check out the issue tracker to make sure someone already hasn’t requested it and/or contributed it.

  • Fork the project.

  • Start a feature/bugfix branch.

  • Commit and push until you are happy with your contribution.

  • Make sure to add tests for it. This is important so I don’t break it in a future version unintentionally.

  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright ↑

Copyright © 2012-2013 Ígor Bonadio. See LICENSE.txt for further details.