From 9997b231d4a003508e8c5cb95569082e690c6d72 Mon Sep 17 00:00:00 2001 From: Diogo Peralta Cordeiro Date: Wed, 14 Apr 2021 15:45:03 +0100 Subject: [PATCH] [INSTALL] Elaborate on localhost installation --- bin/configure | 2 +- docs/src/install/docker_shell.md | 14 ++++++++++---- 2 files changed, 11 insertions(+), 5 deletions(-) diff --git a/bin/configure b/bin/configure index 0a664e8e8e..5d36c6d6b1 100755 --- a/bin/configure +++ b/bin/configure @@ -140,7 +140,7 @@ fi # -------------------------------- PHP ------------------------------------- if echo "${DOCKER}" | grep -Fq '"php"'; then ${WHIPTAIL} --title "Build PHP container locally?" --clear --backtitle 'GNU social' \ - --yesno "\nDo you want to use a compile the needed PHP extensions and build the container locally? (may provide better performance, needs more than 1GiB of RAM)" 0 0 \ + --yesno "\nDo you want to compile the needed PHP extensions and build the container locally? (May provide better performance but requires more than 1GiB of RAM)" 0 0 \ 3>&1 1>&2 2>&3 BUILD_PHP=$((1-$?)) # Invert output fi diff --git a/docs/src/install/docker_shell.md b/docs/src/install/docker_shell.md index 0ab1c7c53d..0f00aaae22 100644 --- a/docs/src/install/docker_shell.md +++ b/docs/src/install/docker_shell.md @@ -2,11 +2,11 @@ ## Installation with Docker -This installation method required +This installation method requires [Docker](https://docs.docker.com/engine/install/) and [Docker Compose](https://docs.docker.com/compose/install/). Use `bin/configure` and pick `docker`, which enables all needed services -as containers, or `mixed` which let's you pick which services you'd +as containers, or `mixed` which lets you pick which services you'd like to create containers for. This way you can use services in the host machine, which may be useful if your host already has a webserver, for instance. @@ -15,6 +15,9 @@ If you elect to not use some service containers, check [Instal without Docker with shell access](./install/no_docker_shell.md) for details on the configuration of each service. +Please remember that for the installation `configure` script to use docker, +it is necessary that the executing user is in the docker group. + ## Prerequisites In order to host your GNU social instance, you'll need a domain: @@ -24,11 +27,14 @@ In order to host your GNU social instance, you'll need a domain: If you don't have a fixed public IP, for local hosting or development, or if you're behind a NAT, use a dynamic DNS solutions. Search for -`GnuDIP host` or `dynamic dns`. To use GnuDIP, clone -[](https://notabug.org/someonewithpc/gnudip.git), then inspect and run +`GnuDIP host` or `dynamic dns`. To use GnuDIP, [clone](https://notabug.org/someonewithpc/gnudip.git), then inspect and run the `./install.sh` script. This allows you to have a domain that dynamically points to your IP address. +If you want to install locally for development or experimenting purposes, +you can use `localhost` as the `root domain` while configuring the installation. +If you then specify a subdomain, don't forget to add it in the `/etc/hosts` file. + {{#include dns.md}} {{#include tls.md}}