aboutsummaryrefslogtreecommitdiffstats
path: root/README.org
diff options
context:
space:
mode:
authorJozanLeClerc <bousset.rudy@gmail.com>2020-07-08 16:54:11 +0200
committerJozanLeClerc <bousset.rudy@gmail.com>2020-07-08 16:54:11 +0200
commitbfa906121e9b088442707601245d2589e3ed9315 (patch)
tree0ca6eafb98877e4f27de87686b71795e3b36a278 /README.org
parentDirectory tree rework (diff)
downloadjoe-scripts-bfa906121e9b088442707601245d2589e3ed9315.tar.gz
joe-scripts-bfa906121e9b088442707601245d2589e3ed9315.tar.bz2
joe-scripts-bfa906121e9b088442707601245d2589e3ed9315.tar.xz
joe-scripts-bfa906121e9b088442707601245d2589e3ed9315.tar.zst
joe-scripts-bfa906121e9b088442707601245d2589e3ed9315.zip
README update
Diffstat (limited to '')
-rw-r--r--README.org34
1 files changed, 33 insertions, 1 deletions
diff --git a/README.org b/README.org
index 8e7ebbb..fa97505 100644
--- a/README.org
+++ b/README.org
@@ -1,3 +1,35 @@
#+TITLE: My server scripts
-These are a bunch of scripts for my VPS server.
+These are a bunch of scripts for my VPS server. They might only run on BSD servers.
+
+* Dependecies
+- *BSD*-type operating system
+- ~perl~
+- ~dash~ shell
+- ~git~
+- ~stagit~
+
+* Functions
+The source tree is the following:
+
+#+BEGIN_SRC shell
+└── src
+ ├── distant
+ ├── gitjoe
+ │   ├── addsshkey.pl
+ │   ├── chdesc.pl
+ │   ├── chowner.pl
+ │   ├── newrepo.pl
+ │   ├── newuser.pl
+ │   ├── rmrepo.pl
+ │   └── rmuser.pl
+ ├── other
+ │   └── git-ro-daemon.pl
+ └── update
+ ├── gitjoe.pl
+ └── serv.pl
+#+END_SRC
+
+- ~gitjoe/~ scripts are meant to be run on the server directly. They are tools to add GitJoe users, repos,
+change descritpion, etc.
+- ~update/~ scripts are run via cron jobs. They update the GitJoe repositories front-end website via ~stagit~ and pull ~master~ branches of the websites via ~git~