https://github.com/c9s/gitorbit

GitHub-like Git Server, let you control the permission via mongodb or LDAP
https://github.com/c9s/gitorbit

git github ssh

Last synced: 19 days ago
JSON representation

GitHub-like Git Server, let you control the permission via mongodb or LDAP

• Host: GitHub
• URL: https://github.com/c9s/gitorbit
• Owner: c9s
• Created: 2018-07-31T23:30:02.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-08-02T06:36:19.000Z (over 6 years ago)
• Last Synced: 2024-05-22T15:32:50.977Z (6 months ago)
• Topics: git, github, ssh
• Language: Go
• Size: 20.5 KB
• Stars: 17
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# GitOrbit

*WORKING IN PRRGRESS*

## Features

- MongoDB-based ssh public key authentication.

- Multiple ssh public key support for each user.

- Kubernetes deployment support.

- Support permission customization.

- LDAP support (WIP)

- Default Permission Configuration (WIP)

## Install

### Setup with Docker 

By default, the git-server image includes a config file:

```json

{

    "mongo": {

        "url": "mongodb://mongo:27017/git"

    },

    "logger": {

        "dir": "/var/log/git",

        "level": "debug",

        "maxAge": "720h",

        "suffixPattern": ".%Y%m%d",

        "linkName": "access_log"

    }

}

```

Which uses `mongodb://mongo:27017/git` as the connection string for the mongo client.

And so you will need to create a mongodb container instance with the name `mongo`, so that

the client can connect to your mongodb server.

First, you need to create a network for sharing the mongodb network connection:

```sh

docker network create docker

```

Start the mongodb server with the network that we just created:

```sh

docker run --name mongo \

    --restart=always \

    --publish 27018:27017 \

    --network docker \

    --detach mongo

```

Get your public key footprint and the key:

```sh

SSH_PUBKEY=$(cat ~/.ssh/id_rsa.pub)

SSH_PUBKEY_FINGERPRINT=$(ssh-keygen -lf ~/.ssh/id_rsa.pub | awk '{ print $2 }')

GIT_USER_EMAIL=$(git config user.email)

```

Insert the user in the mongodb:

```sh

mongo mongodb://localhost:27018/git --eval "

    db.users.insert({

        email: \"$GIT_USER_EMAIL\",

        keys: [{

                \"name\": \"dev\",

                \"fingerprint\": \"$SSH_PUBKEY_FINGERPRINT\",

                \"key\": \"$SSH_PUBKEY\"

            }]

    })"

```

Ensure that you can find the user by the fingerprint:

```sh

mongo mongodb://localhost:27018/git --eval "db.users.find({

    \"keys.fingerprint\": \"$SSH_PUBKEY_FINGERPRINT\" }).pretty()"

```

Build and Run the git server:

```sh

make stop build run

```

Add an entry in your .ssh/config:

```ssh

Host git-server

    HostName localhost

    User git

    Port 2022

    LogLevel INFO

    PreferredAuthentications publickey

    IdentityFile ~/.ssh/id_rsa

```

Now you can try git clone:

```sh

git clone git@git-server:test.git

```

### Kubernetes

Copy the config from the template:

```

cp -v config/default.json k8s.json

```

Configure your settings:

```

vim k8s.json

```

Create configmap object in your cluster:

```

kubectl create configmap git-server-config --from-file=authorized_keys.json=k8s.json

```

To be continued.

## License

MIT License

## Author

Yo-An Lin