Update readme

This commit is contained in:
Pere Lev 2024-08-07 13:24:01 +03:00
parent 94762ca76c
commit e1c952a3b2
No known key found for this signature in database
GPG key ID: 5252C5C863E5E57D

110
README.md
View file

@ -102,114 +102,6 @@ A few more little notes:
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. It
hasn't been updated in a long time, actually, but soon I'll get to it.
[ ] - To do
[~] - Work in progress
[/] - Initial coding done, needs tests and polishing
[x] - Complete
[ ] User management
[~] View your personal overview
[~] Other users' pages
[/] Register
[ ] Delete account
[/] Log in
[/] Log out
[ ] Reset password
[ ] TLS client cert
[ ] Upload it
[ ] View it
[ ] Log in using it
[ ] Change profile details
[/] Key management
[/] Add key
[/] Delete key
[/] View keys
[ ] Project management
[/] Tickets
[ ] Wiki
[ ] Kanban
[ ] Merge requests
[ ] Repo management
[ ] Delete repo
[/] Add repo
[ ] Rename repo
[ ] Edit repo settings
[ ] View repo content
[/] File tree
[ ] File content
[/] Plain text
[/] Syntax highlighting
[/] Document rendering
[ ] Images
[ ] Audio
[ ] Video
[ ] Raw file download
[ ] Darcs
[ ] Create new repo
[/] Web
[ ] SSH
[ ] Delete repo
[/] Web
[ ] SSH
[/] Clone
[/] HTTP
[/] SSH
[/] Pull
[/] HTTP
[/] SSH
[ ] Push
[ ] HTTP
[/] SSH
[/] View
[/] History
[/] Files
[ ] Git
[ ] Create new repo
[/] Web
[ ] SSH
[ ] Delete repo
[/] Web
[ ] SSH
[ ] Clone
[/] HTTP
[/] SSH
[ ] Git
[ ] Pull
[/] HTTP
[/] SSH
[ ] Git
[ ] Push
[ ] HTTP
[/] SSH
[/] View
[/] History
[/] Files
[~] Federation
## Reliability requirements
These features are considered critical for a Vervis instance to be a reasonably
reliable place where people can host their projects and repos, and not worry
about some bug or missing feature causing loss of data or access.
[ ] Password reset, at least over plain email, either automatically or a
temporary manual hack which will work at least for personal instances
[x] Git pull and push over SSH fully working
[x] Darcs pull and push over SSH fully working
[x] SSH server implementation really secure as far as I know
[x] TLS support, especially critical when sending passwords. For now, done
externally through Lighttpd, not Vervis itself
[x] Darcs pull over HTTP and HTTPS
[x] Git pull over HTTP and HTTPS
[ ] Clear policy and guidelines for DB schema changes
[ ] Running instance has data backups
## Federation & API
See `FEDERATION.md` & `API.md`.
@ -306,7 +198,7 @@ solve it.
If you're going to implement some feature or fix some bug you found, **start by
opening a ticket**
[here](https://vervis.peers.community/decks/br6Go) so that other
[here](https://codeberg.org/ForgeFed/Vervis/issues) so that other
people will know which features are being developed and who does what.
UPDATE: The ticket tracker is temporarily unavailable. You can instead contact