aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorjwansek <eddie.atten.ea29@gmail.com>2022-09-20 23:38:36 +0100
committerjwansek <eddie.atten.ea29@gmail.com>2022-09-20 23:38:36 +0100
commit0622363f32676c19985396177c93dbc58785925f (patch)
tree86be4d15d2e8b60325829dfa39f1e840bdc94cfb /README.md
parenta45c5119711a4140b9710ef96ddf0578d5cf9cd3 (diff)
downloadgit-scripts-0622363f32676c19985396177c93dbc58785925f.tar.gz
git-scripts-0622363f32676c19985396177c93dbc58785925f.zip
Renamed scripts, improved README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 16 insertions, 1 deletions
diff --git a/README.md b/README.md
index d7aa964..54a0ea1 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,17 @@
# git-scripts
-Scripts used for configuration of my git server - git.eda.gay
+Interactive scripts used for configuration of my git server - git.eda.gay
+
+## Scripts
+
+It is recommended to make symlinks to the home directory- e.g.:
+`ln -s $(pwd)/add_git_key.sh ~/add_git_key && chmod +x ~/add_git_key`
+`ln -s $(pwd)/del_repo.sh ~/del_repo && chmod +x ~/del_repo`
+`ln -s $(pwd)/make_repo.py ~/make_repo && chmod +x ~/make_repo`
+`ln -s $(pwd)/show_gitkey.py ~/show_gitkey && chmod +x ~/show_gitkey`
+`ln -s $(pwd)/del_repo.sh ~/rm_repo && chmod +x ~/rm_repo`
+
+Then repositories can be created with `ssh git@git.eda.gay "./make_repo"` or removed with `ssh git@git.eda.gay "./rm_repo"`.
+
+## Web UI
+
+Repositories that are set to public are rendered using [klaus](https://github.com/jonashaag/klaus), using a custom CSS file and Dockerfile. This is in the `klaus/` directory.