mediocregopher/dehub
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Documentation fixes for dehub-remote and git-http-server

Browse Source 
---
type: change
message: Documentation fixes for dehub-remote and git-http-server
change_hash: AHgOc66WotsrgX4qfuIWuI1kcI1prxoUvd4L5VKR3onI
credentials:
- type: pgp_signature
  pub_key_id: 95C46FA6A41148AC
  body: iQIzBAABAgAdFiEEJ6tQKp6olvZKJ0lwlcRvpqQRSKwFAl6BI0UACgkQlcRvpqQRSKxcww//fSTl5noQ7ozmlchJjE+Us0RLDK4OCjKriEvF1eaulJQNYEu+d4YJCoCJ0GMQoRvng3zgbal+juHTCZVERCI3Q8wkAk3j6UxYPcuUfzH4DAZmwH7Y9EpwofXeB3ZnVypObQpy0EzlaqIfbk/UAvMuZc+u4c+0wFUR8gBk8rydnpAV4okD6t56U8uUwQtjvF1siCakcCSEHKRx2juDdjwMIA95BebsTZ+SiBgwh2p7sWbRn2+WCqCU0F62esG+1OHeSSkQFF2nI4Wz7t3iZfmMRExsxyfnvyTRlvDuvHNb/3d9hh+7oQmeZ1YcNOwbeWOY7MmO1cTqMbg+oaf3KOj04kyQg8oDPJZfFadW7a9ITzj+O8zVGJZXTDh6A6FVTfTnwx1t04JrkAncnd7/lQTYbRk8RcIrFtzXUkbd9l7eucooINk+sRek4jvGexQZhMjATaC6Qe1lHgYH0raWeAaoFfTXIqPlGPvsCSU8jBivZqvDrXF8u+2sneLKXw2EFmXp5OvzzIP40htZHNTX58Mx7D+09sIxJU3rN1R/bvxidyMW/+EKiP/3JgEW7kXPOc1tRdEMb1rJ6Iufy6mCkNgZXboI1uAr0Q9JB3GB08ocf2JA8mhSpuVWUssF0u3i5R47dmbwxsc3v4V/i8xPoO05b/n5I3TmLqR0ewiXUvCR4J8=
  account: mediocregopher
This commit is contained in:
mediocregopher 2020-03-29 16:38:08 -06:00
parent d5f172875e
commit 921572d053
3 changed files with 17 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -92,6 +92,10 @@ in its coverage.
[ROADMAP](/ROADMAP.html) documents upcoming features and other work required on [ROADMAP](/ROADMAP.html) documents upcoming features and other work required on
the project. If you're looking to contribute, this is a great place to start. the project. If you're looking to contribute, this is a great place to start.
[dehub-remote](/cmd/dehub-remote) TODO [dehub-remote](/cmd/dehub-remote/) is a simple docker image which can be used to
host a remote dehub project over http(s). The endpoint will automatically verify
all pushed commits.
[git-http-server](/cmd/git-http-server) TODO [git-http-server](/cmd/git-http-server/) is a small server which makes a git
repo's file tree available via http. It will automatically render markdown files
to html as well. git-http-server is used to render dehub's website.

7
cmd/dehub-remote/README.md
View File

@ -18,7 +18,6 @@ Running the following:
docker run \ docker run \
--name dehub \ --name dehub \
-v /opt/dehub/repos:/repos \ -v /opt/dehub/repos:/repos \
-v /opt/dehub/www:/var/www \
-p 8080:80 \ -p 8080:80 \
mediocregopher/dehub-remote repo-a.git repo-b.git mediocregopher/dehub-remote repo-a.git repo-b.git
``` ```
@ -28,8 +27,10 @@ repo folders. It will then initialize repo directories at
`/opt/dehub/repos/repo-a.git` and `/opt/dehub/repos/repo-b.git`, if they arent `/opt/dehub/repos/repo-a.git` and `/opt/dehub/repos/repo-b.git`, if they arent
already there. already there.
If a volume for `/var/www` is given then that will be used as the root for all ## Extras
non-git http requests.
For convenience the docker image also includes the
[git-http-server](../git-http-server/) binary.
## Contributors ## Contributors

9
cmd/git-http-server/README.md
View File

@ -4,14 +4,19 @@ A simple http server which uses a git repo (bare or otherwise) as the underlying
filesystem. filesystem.
* Automatically renders markdown files as html. * Automatically renders markdown files as html.
* Will use README.md as the index, if available. * Will use `README.md` as the index, if available.
* Can be set to use a specific branch. * Can be set to use a specific branch.
All configuration is done on the command-line. All configuration is done on the command-line.
# Installation # Installation
TODO Installation of git-http-server is done in the same manner as the `dehub`
command itself:
```
go get dehub.dev/src/dehub.git/cmd/git-http-server
```
# Markdown # Markdown