Bug 17951: Make koha-create set template_cache_dir correctly

[koha.git] / debian / docs / koha-create.xml

diff --git a/debian/docs/koha-create.xml b/debian/docs/koha-create.xml
index d3f186b..632140d 100644 (file)
--- a/debian/docs/koha-create.xml
+++ b/debian/docs/koha-create.xml
@@ -26,7 +26,7 @@
       <command>koha-create</command>
       <arg choice="req"><option>--create-db</option>|<option>--request-db</option>|<option>--populate-db</option>|<option>--use-db</option></arg>
       <arg><option>--marcflavor</option> marc21|normarc|unimarc</arg>
-      <arg><option>--zebralang</option> en|es|fr|nb|ru|uk</arg>
+      <arg><option>--zebralang</option> en|es|fr|gr|nb|ru|uk</arg>
       <arg><option>--auth-idx</option> dom|grs1</arg>
       <arg><option>--biblio-idx</option> dom|grs1</arg>
       <arg><option>--use-memcached</option></arg>
@@ -35,10 +35,14 @@
       <arg><option>--defaultsql</option> /path/to/some.sql</arg>
       <arg><option>--configfile</option> /path/to/config</arg>
       <arg><option>--passwdfile</option> /path/to/passwd</arg>
+      <arg><option>--dbhost</option> host</arg>
       <arg><option>--database</option> database</arg>
       <arg><option>--adminuser</option> n</arg>
       <arg><option>--enable-sru</option></arg>
       <arg><option>--sru-port</option> port</arg>
+      <arg><option>--template-cache-dir</option> directory</arg>
+      <arg><option>--upload-path</option> directory</arg>
+      <arg><option>--letsencrypt</option></arg>
       <arg><option>--help</option>|<option>-h</option></arg>
 
       <arg choice="req" rep="norepeat"><replaceable>instancename</replaceable></arg>
@@ -90,6 +94,13 @@
       </listitem>
     </varlistentry>
 
+    <varlistentry>
+      <term><option>--dbhost</option></term>
+      <listitem>
+        <para>Database server hostname/IP to use.</para>
+      </listitem>
+    </varlistentry>
+
     <varlistentry>
       <term><option>--defaultsql</option></term>
       <listitem>
@@ -97,6 +108,13 @@
       </listitem>
     </varlistentry>
 
+    <varlistentry>
+      <term><option>--adminuser</option></term>
+      <listitem>
+        <para>Specify the borrowernumber of the user that should have a new, random password set as part of setting up the new instance. The password will be reported as part of the output of the current script. If --adminuser is not specified, the user with borrowernumber = 1 will be updated. If an SQL file is not used to populate the database of the newly created instance, no admin user will be created.</para>
+      </listitem>
+    </varlistentry>
+
     <varlistentry>
       <term><option>--marcflavor</option></term>
       <listitem>
@@ -167,6 +185,29 @@
       </listitem>
     </varlistentry>
 
+    <varlistentry>
+      <term><option>--template-cache-dir</option></term>
+      <listitem>
+        <para>Specify a <option>directory</option> for storing the template cache files of the instance.
+              It defaults to <filename>/var/cache/koha/instance/templates</filename>.</para>
+      </listitem>
+    </varlistentry>
+
+    <varlistentry>
+      <term><option>--upload-path</option></term>
+      <listitem>
+        <para>Specify a <option>directory</option> for storing the permanently uploaded files of the instance.
+              It defaults to <filename>/var/lib/koha/instance/uploads</filename>.</para>
+      </listitem>
+    </varlistentry>
+
+    <varlistentry>
+      <term><option>--letsencrypt</option></term>
+      <listitem>
+        <para>Set up a https-only website with letsencrypt certificates</para>
+      </listitem>
+    </varlistentry>
+
     <varlistentry>
       <term><option>--help</option>,<option>-h</option></term>
       <listitem>
@@ -241,6 +282,7 @@
         <term><option>DEFAULTSQL</option></term>
         <listitem>
           <para>An SQL file (compressed with gzip) that can be fed  to  mysql(1) to  initialize the database after it has been created.  Might be created using koha-dump-defaults(8).</para>
+          <para>If the SQL file contains users, the user with borrowernumber = 1 will have a new, random password set. This password will be reported in the output of the script. If another user than borrowernumber 1 should have its password set, the borrowernumber of this user can be set with the --adminuser command line option.</para>
         </listitem>
       </varlistentry>
 
@@ -305,7 +347,7 @@
     <varlistentry>
       <term><option><filename>/etc/koha/passwd</filename></option></term>
       <listitem>
-        <para>Pre-selected database credentials are read from this file, if it exists. The format for this file is instancename:username:passwd:database. Database is optional, but the other three are required if you want to use pre-determined database user credentials.</para>
+        <para>Pre-selected database credentials are read from this file, if it exists. The format for this file is instancename:username:passwd:database:dbhost. Database is optional, but the other three are required if you want to use pre-determined database user credentials.</para>
       </listitem>
     </varlistentry>
   </variablelist>