aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/installation
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src/installation')
-rw-r--r--doc/src/installation/README.md3
-rw-r--r--doc/src/installation/creating-admin.md7
-rw-r--r--doc/src/installation/db-setup.md21
-rw-r--r--doc/src/installation/safety.md10
4 files changed, 41 insertions, 0 deletions
diff --git a/doc/src/installation/README.md b/doc/src/installation/README.md
new file mode 100644
index 0000000..3ccd2f9
--- /dev/null
+++ b/doc/src/installation/README.md
@@ -0,0 +1,3 @@
+# Installing Hubzilla
+
+Once the Hubzilla DDEV environment is up and running, you can set up Hubzilla as usual using the Hubzilla Web UI.
diff --git a/doc/src/installation/creating-admin.md b/doc/src/installation/creating-admin.md
new file mode 100644
index 0000000..72fa933
--- /dev/null
+++ b/doc/src/installation/creating-admin.md
@@ -0,0 +1,7 @@
+# Creating the admin user
+
+When it comes to creating the admin user, you can type in any email address in the email field. Outgoing emails are caught by the builtin Mailpit service, and you can access them by visiting `https://hubzilla-ddev.ddev.site:8026`[^note] (or by typing `ddev mailpit` in the terminal.)
+
+Use that to get the registration token you need to register the first user.
+
+[^note]: Adapt as necessary for your setup.
diff --git a/doc/src/installation/db-setup.md b/doc/src/installation/db-setup.md
new file mode 100644
index 0000000..853146a
--- /dev/null
+++ b/doc/src/installation/db-setup.md
@@ -0,0 +1,21 @@
+# Database setup
+
+By default the dev environment is set up with a Postgres database running on the host reachable as `db` from within the docker container where the code is running. In the setup screen, set the type to "PostgreSQL", leave the "Port" as 0, and set all the other fields to `db`,
+
+The generated `.htconfig.php` file should contain the following after you're done:
+
+```
+$db_host = 'db';
+$db_port = '0';
+$db_user = 'db';
+$db_pass = 'db';
+$db_data = 'db';
+$db_type = '1'; // an integer. 0 or unset for mysql, 1 for postgres
+```
+
+If you prefer to use MySQL or Mariadb as the database backend instead, you can change this by issuing the command:
+```
+% ddev config --database=mariadb:10.11
+```
+
+And then restart the environment by running `ddev restart`.
diff --git a/doc/src/installation/safety.md b/doc/src/installation/safety.md
new file mode 100644
index 0000000..2fed69d
--- /dev/null
+++ b/doc/src/installation/safety.md
@@ -0,0 +1,10 @@
+# Safety notes
+
+Be aware that this hub will run in an isolated network on your local machine, and while it will be able to reach out to other sites on the internet, it is _not reachable_ from the outside.
+
+In other words: _don't try to connect to other users on real hubs or fediverse instances!_
+
+You may want modify the directory mode line in your generated `.htconfig.php` like this to be on the safe side:
+```
+App::$config['system']['directory_mode'] = DIRECTORY_MODE_STANDALONE;
+```