summaryrefslogtreecommitdiff
path: root/install
diff options
context:
space:
mode:
authorÉtienne Loks <etienne.loks@iggdrasil.net>2023-11-15 14:19:25 +0100
committerÉtienne Loks <etienne.loks@iggdrasil.net>2025-02-19 16:15:49 +0100
commit86bdef4a42003bb65d553b7c8cc2a56ca1b1bf27 (patch)
tree25eec480630d2a93468ba2f8ba0bd9424bdadd9c /install
parent28e21edb8c9a15f25b8a469fc6403c5c0c25c2c5 (diff)
downloadIshtar-86bdef4a42003bb65d553b7c8cc2a56ca1b1bf27.tar.bz2
Ishtar-86bdef4a42003bb65d553b7c8cc2a56ca1b1bf27.zip
🚀 Debian package: python-django-ishtar - add man page - fix copyright file
Diffstat (limited to 'install')
-rw-r--r--install/ishtar-delete-instance.824
-rw-r--r--install/ishtar-prepare-instance.826
2 files changed, 50 insertions, 0 deletions
diff --git a/install/ishtar-delete-instance.8 b/install/ishtar-delete-instance.8
new file mode 100644
index 000000000..310f299a0
--- /dev/null
+++ b/install/ishtar-delete-instance.8
@@ -0,0 +1,24 @@
+.\" Manpage for ishtar-delete-instance.
+.TH man 8 "15 Nov 2023" "1.0" "ishtar-delete-instance man page"
+.SH NAME
+ishtar-delete-instance \- create a new ishtar instance
+.SH SYNOPSIS
+ishtar-delete-instance
+.SH DESCRIPTION
+ishtar-delete-instance remove:
+.IP \[bu] 3
+instance configuration files (python django settings, nginx, uwsgi, supervisor and monit).
+.IP \[bu]
+the associated "/srv/ishtar/instance_name" directory.
+.IP \[bu]
+if relevant the dedicated rabbitmq queue.
+.IP \[bu]
+the associated database.
+.SH OPTIONS
+ishtar-delete-instance does not take any options.
+.SH SEE ALSO
+ishtar-prepare-instance(8)
+.SH BUGS
+No known bugs.
+.SH AUTHOR
+Étienne Loks (etienne.loks@iggdrasil.net) \ No newline at end of file
diff --git a/install/ishtar-prepare-instance.8 b/install/ishtar-prepare-instance.8
new file mode 100644
index 000000000..e1784c5fe
--- /dev/null
+++ b/install/ishtar-prepare-instance.8
@@ -0,0 +1,26 @@
+.\" Manpage for ishtar-prepare-instance.
+.TH man 8 "15 Nov 2023" "1.0" "ishtar-prepare-instance man page"
+.SH NAME
+ishtar-prepare-instance \- create a new ishtar instance
+.SH SYNOPSIS
+ishtar-prepare-instance
+.SH DESCRIPTION
+The script ask for instance name, instance url and max upload size.
+
+Then ishtar-prepare-instance create:
+.IP \[bu] 3
+configuration files (python django settings, nginx, uwsgi, supervisor and monit).
+.IP \[bu]
+an instance dir ("/srv/ishtar/instance_name") from a default template dir.
+.IP \[bu]
+a default database with initial data.
+.IP \[bu]
+if relevant (background task service is available) a dedicated rabbitmq queue.
+.SH OPTIONS
+ishtar-prepare-instance does not take any options
+.SH SEE ALSO
+ishtar-prepare-instance(8)
+.SH BUGS
+No known bugs.
+.SH AUTHOR
+Étienne Loks (etienne.loks@iggdrasil.net) \ No newline at end of file