Add documentation about docker-compose.yml and database

wishthis · Nov 11, 2023 · 8d2c204 · 8d2c204
2 parents 4eab75f + ef67db4
commit 8d2c204
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 9 deletions.
diff --git a/.github/workflows/docker-publish.yml b/.github/workflows/docker-publish.yml
@@ -53,7 +53,9 @@ jobs:
         with:
           context: .
           push: true
-          tags: stable
+          tags: |
+           hiob/wishthis:stable
+           ghcr.io/${{ github.repository }}:stable
           labels: ${{ steps.meta.outputs.labels }}
           build-args: WISHTHIS_GITBRANCH=stable
 
@@ -62,7 +64,9 @@ jobs:
         with:
           context: .
           push: true
-          tags: develop
+          tags: |
+           hiob/wishthis:develop
+           ghcr.io/${{ github.repository }}:develop  
           labels: ${{ steps.meta.outputs.labels }}
           build-args: WISHTHIS_GITBRANCH=develop
 
@@ -71,6 +75,9 @@ jobs:
         with:
           context: .
           push: true
-          tags: release-candidate
+          tags: |
+           hiob/wishthis:release-candidate
+           ghcr.io/${{ github.repository }}:release-candidate
           labels: ${{ steps.meta.outputs.labels }}
-          build-args: WISHTHIS_GITBRANCH=release-candidate            
+          build-args: WISHTHIS_GITBRANCH=release-candidate
+
diff --git a/Dockerfile b/Dockerfile
@@ -1,4 +1,4 @@
-# Wishthis - Unofficial docker image
+# Wishthis - Official docker image
 FROM php:8.1-apache
 
 # Maintainer
@@ -64,7 +64,7 @@ RUN echo '%sudo ALL=(ALL) NOPASSWD:ALL' >> /etc/sudoers
 USER www-data
 
 # GET WISHTHIS
-## Git clone grandeljay/wishthis (default stable branch)
+## Git clone wishthis/wishthis (default: stable branch)
 ARG WISHTHIS_GITBRANCH=stable
 ENV WISHTHIS_GITBRANCH $WISHTHIS_GITBRANCH
 RUN git --version && echo '...Cloning $WISHTHIS_GITBRANCH branch...'

diff --git a/README.md b/README.md
@@ -1,15 +1,23 @@
 ![wishthis logo](https://raw.githubusercontent.com/wishthis/wishthis/develop/src/assets/img/logo-readme.svg "wishthis logo")
 
-# wishthis - [official docker image](https://hub.docker.com/r/hiob/wishthis)
+# wishthis - [Official docker image](https://hub.docker.com/r/hiob/wishthis)
 [wishthis](https://wishthis.online/) is a simple, intuitive and modern wishlist platform to create, manage and view your wishes for any kind of occasion.
 
 ## wishthis : documentation and setup
 Always refer you to [wishthis documentation](https://github.com/wishthis/wishthis/).
 
 ## Docker : usage
 You can find support and an updated documentation on our [Github's repository](https://github.com/wishthis/docker/).
+We host ours docker images on [Docker's hub](https://hub.docker.com/r/hiob/wishthis) or [ghcr.io](https://ghcr.io/wishthis/docker)
+
+Three tags/images are avalaibles: 
+- **develop** : for Wishthis's [*develop branch*](https://github.com/wishthis/wishthis/tree/develop)
+- **release-candidate** : for Wishthis's [*release-candidate branch*](https://github.com/wishthis/wishthis/tree/release-candidate)
+- **stable** : for Wishthis's [*stable branch*](https://github.com/wishthis/wishthis/tree/stable)
 
 ### Docker-compose
+Always refer you to [Docker compose documentation](https://docs.docker.com/compose/reference/).
+
 Here a sample of [docker-compose.yml](sample/docker-compose.yml.sample) :
 
 ```
@@ -19,13 +27,18 @@ services:
   wishthis:
     container_name: wishthis
     restart: unless-stopped
-    image: hiob/wishthis:latest
+    image: hiob/wishthis:stable
     ports:
       - 80:80
     volumes:
       - ./config.php:/var/www/html/src/config/config.php
 ```
 
+Wishthis will be available to http://localhost:80. 
+
+You can use a reverse proxy ([Nginx](https://www.nginx.com/),[ Traefik](https://doc.traefik.io/traefik/getting-started/quick-start/), [SWAG](https://docs.linuxserver.io/general/swag)...) to serve wishthis with is own (sub)domain name. 
+
 ### Permanent configuration
+At first launch, if you didn't create a Wishthis's configuration file by mounting a permanent volume, You will be invite to setup Wishthis and database.
 
 To keep your database configuration  permanent, mount a volume (see example above), create a file named `config.php` and copy the [`config-sample.php` from Github's repo](https://github.com/wishthis/wishthis/blob/develop/src/config/config-sample.php).
diff --git a/sample/docker-compose.yml.sample b/sample/docker-compose.yml.sample
@@ -4,6 +4,8 @@ services:
   wishthis:
     container_name: wishthis
     restart: unless-stopped
-    image: hiob/wishthis:0.7.0
+    image: hiob/wishthis:stable
+    ports:
+      - 80:80
     volumes:
       - ./config.php:/var/www/html/src/config/config.php