Skip to content
Permalink
Browse files

Document the repo create command

Signed-off-by: Randy Barlow <randy@electronsweatshop.com>
  • Loading branch information...
bowlofeggs authored and mergify committed Aug 29, 2019
1 parent ca2fcc4 commit 5c2c8f6ea9ad976f4a42ea1a09882f0105566451
Showing with 19 additions and 16 deletions.
  1. +19 −16 README.md
@@ -1,5 +1,4 @@
repoSpanner
===========
# repoSpanner

repoSpanner is a distributed repository storage server, based around Git.

@@ -15,15 +14,13 @@ push failing due to an attempt to push to the failed node.
*Note*: As a consequence of this, it is strongly suggested to deploy
regions with odd numbers of nodes.

Build repoSpanner
-----------------
## Build repoSpanner

Make sure you have a Go toolchain available, and run:

$ ./build.sh

Deployment
----------
## Deployment

A repoSpanner deployment is called a "cluster", which consists of one or
more "regions", which contain one or more "nodes". A cluster contains
@@ -90,11 +87,21 @@ And then run:

Or, again, start the `repospanner.service` unit file.

Repository access
-----------------
## Repository access

After this, the service will be available on https://<node.fqdn>/

### Create

You can create repositories with ```repospanner admin repo create <name>```, for
example:

```
$ repospanner admin repo create repospanner
```

### Clone

For git repo pull/push, add a /repo/<repo-name>.git.
Example clone command for default https port on tcp/443 and repo name being "test"

@@ -113,8 +120,7 @@ in /etc/repospanner.
This client will automatically revert to plain git if it determines the repo
that is being pushed to is not a repospanner repository.

Development
-----------
## Development

For development, standard github pull requests are used.
Most changes do not require special tools other than the standard build
@@ -129,23 +135,20 @@ To run the full test suite, run from the main directory:

$ go test ./...

Tests
-----
## Tests

The project comes with a decent functional test suite. Explore the
`repospanner/functional_tests` to see the variety of tests that you can
run.

Contributions
-------------
## Contributions

Contributions are most welcome.
Please make sure to add a `Signed-Off-By` line in your git commit to indicate
you agree to the Developer Certificate of Origin (DCO) as quoted below.
To do this, simple add the "-s" flag to your git commit, like: `git commit -s`.

Developer Certificate of Origin
--------------------------------
## Developer Certificate of Origin

Developer Certificate of Origin
Version 1.1

0 comments on commit 5c2c8f6

Please sign in to comment.
You can’t perform that action at this time.