Update README with instructions for trying my instance
This commit is contained in:
fr33domlover
parent
bec9290783
commit
9b897087c3
1 changed files with 108 additions and 11 deletions
119
README.md
119
README.md
|
|
@ -1,20 +1,115 @@
|
|||
# Vervis
|
||||
|
||||
**Vervis** is a project hosting and management application, with a focus on
|
||||
softare projects and decentralization. It's still in very early development. At
|
||||
the time of writing, it is a minimal web application in which you can create
|
||||
Git repositories and watch their commit logs.
|
||||
softare projects and decentralization. There is still a lot to do, but if you'd
|
||||
like to try it, a few things more or less work. See below for details.
|
||||
|
||||
Vervis is free software, and is committed to software freedom and to freedom in
|
||||
general. It is released to the public domain using the CC0 Public Domain
|
||||
Dedication. For the boring "legal" details, see the file `COPYING`. Please use
|
||||
general. Most of its code is in the public domain using the CC0 Public Domain
|
||||
Dedication. The application as a whole however is released under AGPL
|
||||
version 3. For the boring "legal" details, see the file `COPYING`. Please use
|
||||
and reuse Vervis for a Good purpose, and share your work too in the same
|
||||
spirit.
|
||||
|
||||
## Try It
|
||||
|
||||
You can either use the existing instance mentioned below, or install your own
|
||||
instance (see `INSTALL.md`).
|
||||
|
||||
My focus has been on writing the backend side of features and exploring various
|
||||
experimental features. As a result, the user interface and visual design and
|
||||
page styles (i.e. the whole UX and UI) are in a bad shape right now, so I want
|
||||
to write a few little guidelines to help you find your way until this situation
|
||||
improves.
|
||||
|
||||
There is a Vervis instance running at <https://dev.seek-together.space>, and I
|
||||
store my code on it. Feel free to use it and try it, however do please treat it
|
||||
as a demo, as it's not a reliable stable instance for general use yet. If for
|
||||
any reason you do with to keep some code and tickets etc. on it for actual use,
|
||||
please contact me to let me know.
|
||||
|
||||
Here are the steps to make the most out of it at this point (at least at the
|
||||
time of writing, I'll try to keep this little tutorial up to date)!
|
||||
|
||||
1. Create an SSH key if you don't have one. Most likely you do, for pushing to
|
||||
your existing repos hosted on your favorite project hosting platform.
|
||||
2. Browse to the instance I linked above, and click *Sign up*. Choose a
|
||||
username and a password. Email address is currently optional on this
|
||||
instance, but it's going to be required soon and used for things like
|
||||
password reset, so please do provide a real email address.
|
||||
3. Log in. Once you log in, the front page will change, and among other things,
|
||||
it will link to your SSH keys. Go there to add your SSH key. In the
|
||||
algorithm box you paste the first part e.g. `ssh-rsa`, and in the second box
|
||||
you paste the long scary part that follows it.
|
||||
4. The front page also links you to repos and projects, you can create a
|
||||
project and open tickets. You can also create a Git or Darcs repo, and
|
||||
optionally associate it with a project. A project can have any number of
|
||||
repos asociated with it, sharing the same ticket tracker. Creating a project
|
||||
or repo may ask you to create a project or repo role; the front page has
|
||||
links for creating these
|
||||
5. You can browse all the projects and repos hosted on the instance.
|
||||
6. Add the following to your `~/.ssh/config` file, or create it if doesn't
|
||||
exist:
|
||||
|
||||
Host dev.seek-together.space
|
||||
Port 5021
|
||||
ControlMaster no
|
||||
ForwardAgent no
|
||||
ForwardX11 no
|
||||
|
||||
Once you create a repository, it is possible that initially, trying to look at
|
||||
it will give you 404. It should be okay though once you push some commit into
|
||||
it.
|
||||
|
||||
The examples below use Darcs, but it's exactly the same for Git. They are
|
||||
equally supported.
|
||||
|
||||
Cloning repositories works over (unauthenticated) HTTPS and (authenticated)
|
||||
SSH.
|
||||
|
||||
**HTTPS clone:**
|
||||
|
||||
$ darcs clone https://dev.seek-together.space/s/fr33domlover/r/vervis
|
||||
|
||||
**SSH clone and push:**
|
||||
|
||||
If your system username and Vervis username are identical:
|
||||
|
||||
$ darcs clone dev.seek-together.space:wistera
|
||||
|
||||
If the repo is under another user:
|
||||
|
||||
$ darcs clone dev.seek-together.space:aviva/poems
|
||||
|
||||
If usernames are different:
|
||||
|
||||
$ darcs clone luke@dev.seek-together.space:wistera
|
||||
|
||||
If the repo is under another user:
|
||||
|
||||
$ darcs clone luke@dev.seek-together.space:aviva/poems
|
||||
|
||||
A few more little notes:
|
||||
|
||||
- No password reset, it's already implemented but not deployed yet at the time
|
||||
of writing these words
|
||||
- A few more features are available, such as ticket workflows and ticket claim
|
||||
requests, but they are less important so I'm not going into them at this
|
||||
point
|
||||
- Deletion of users, projects and repos may not work
|
||||
- Login session should last for 2 hours after last access
|
||||
- The instance I'm running serves only HTTPS, no plain HTTP
|
||||
- There's no HTTPS push
|
||||
- Merge requests not implemented yet
|
||||
- I started working on federation using ActivityPub, I'll update here when it's
|
||||
ready for trying against ActivityPub clients and servers
|
||||
- Feedback is very very very very very welcome and needed!!! :)
|
||||
|
||||
## Features
|
||||
|
||||
This is a list of initial features I plan to support in Vervis. It helps me get
|
||||
an overview of more-or-less what's left to do before the first release.
|
||||
an overview of more-or-less what's left to do before the first release. It
|
||||
hasn't been updated in a long time, actually, but soon I'll get to it.
|
||||
|
||||
[ ] - To do
|
||||
[~] - Work in progress
|
||||
|
|
@ -132,10 +227,11 @@ control.
|
|||
|
||||
The official download location is the Darcs repository:
|
||||
|
||||
<http://hub.darcs.net/fr33domlover/vervis>
|
||||
<https://dev.seek-together.space/s/fr33domlover/r/vervis>
|
||||
|
||||
Releases are made to Hackage, the Haskell package repository.
|
||||
See <http://hackage.haskell.org/package/vervis>.
|
||||
There is a backup repo, not always up to date though, at:
|
||||
|
||||
<https://hub.darcs.net/fr33domlover/vervis>
|
||||
|
||||
See the file `INSTALL.md` for a detailed usage and deployment guide. The file
|
||||
`ChangeLog` explains how to see the history log of the changes done in the
|
||||
|
|
@ -147,8 +243,9 @@ If you found a bug, or you have an idea, a feature request or a wishlist item,
|
|||
open a ticket for it! Even if you're goint to implement something or try to
|
||||
solve it.
|
||||
|
||||
<http://rel4tion.org/projects/vervis/tickets/>
|
||||
|
||||
If you're going to implement some feature or fix some bug you found,
|
||||
**start by opening a ticket** so that other people will know which features are
|
||||
being developed and who does what.
|
||||
|
||||
Hmmm no ticket tracker at this moment, it's coming soon though! For now, email
|
||||
me (see `AUTHORS.md`).
|
||||
|
|
|
|||
Loading…
Reference in a new issue