[MISC] Restructure repo folder layout (#628)

.gitignore

@@ -31,7 +31,7 @@ dist/
 /config.yml
 /config.test.yml
 
-example/ldap/private.ldif
+internal/suites/example/ldap/private.ldif
 
 Configuration.schema.json
 

README.md

@@ -4,14 +4,14 @@
 <!-- Current release: 4.3.0 -->
 
   [![Build](https://img.shields.io/buildkite/d6543d3ece3433f46dbe5fd9fcfaf1f68a6dbc48eb1048bc22/master?style=flat-square&color=brightgreen)](https://buildkite.com/authelia/authelia)
-  [![Go Report Card](https://goreportcard.com/badge/github.com/authelia/authelia)](https://goreportcard.com/report/github.com/authelia/authelia)
+  [![Go Report Card](https://goreportcard.com/badge/github.com/authelia/authelia?style=flat-square)](https://goreportcard.com/report/github.com/authelia/authelia)
   [![Docker Tag](https://images.microbadger.com/badges/version/authelia/authelia.svg)](https://microbadger.com/images/authelia/authelia)
   [![Docker Size](https://img.shields.io/microbadger/image-size/authelia/authelia?logo=docker&style=flat-square&color=blue)](https://microbadger.com/images/authelia/authelia)
   [![GitHub Release](https://img.shields.io/github/release/authelia/authelia.svg?logo=github&style=flat-square&color=blue)](https://github.com/authelia/authelia/releases)
   [![AUR source version](https://img.shields.io/aur/version/authelia?logo=arch-linux&label=authelia&style=flat-square&color=blue)](https://aur.archlinux.org/packages/authelia/)
   [![AUR binary version](https://img.shields.io/aur/version/authelia-bin?logo=arch-linux&label=authelia-bin&style=flat-square&color=blue)](https://aur.archlinux.org/packages/authelia-bin/)
   [![AUR development version](https://img.shields.io/aur/version/authelia-git?logo=arch-linux&label=authelia-git&style=flat-square&color=blue)](https://aur.archlinux.org/packages/authelia-git/)
-  [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg?style=flat-square)][Apache 2.0]
+  [![License](https://img.shields.io/github/license/authelia/authelia?style=flat-square&color=blue)][Apache 2.0]
   [![Sponsor](https://img.shields.io/badge/donate-opencollective-blue.svg?style=flat-square)](https://opencollective.com/authelia-sponsors)
   [![Matrix](https://img.shields.io/matrix/authelia:matrix.org?logo=matrix&style=flat-square&color=blue)](https://riot.im/app/#/room/#authelia:matrix.org)
 

cmd/authelia-scripts/cmd_ci.go

@@ -6,14 +6,14 @@ import (
 	"github.com/spf13/cobra"
 )
 
-const dockerPullCommandLine = "docker-compose -f docker-compose.yml " +
+const dockerPullCommandLine = "docker-compose -p authelia -f internal/suites/docker-compose.yml " +
-	"-f example/compose/mariadb/docker-compose.yml " +
+	"-f internal/suites/example/compose/mariadb/docker-compose.yml " +
-	"-f example/compose/redis/docker-compose.yml " +
+	"-f internal/suites/example/compose/redis/docker-compose.yml " +
-	"-f example/compose/nginx/portal/docker-compose.yml " +
+	"-f internal/suites/example/compose/nginx/portal/docker-compose.yml " +
-	"-f example/compose/smtp/docker-compose.yml " +
+	"-f internal/suites/example/compose/smtp/docker-compose.yml " +
-	"-f example/compose/httpbin/docker-compose.yml " +
+	"-f internal/suites/example/compose/httpbin/docker-compose.yml " +
-	"-f example/compose/ldap/docker-compose.admin.yml " +
+	"-f internal/suites/example/compose/ldap/docker-compose.admin.yml " +
-	"-f example/compose/ldap/docker-compose.yml " +
+	"-f internal/suites/example/compose/ldap/docker-compose.yml " +
 	"pull"
 
 // RunCI run the CI scripts

docs/deployment-production.md

@@ -49,7 +49,7 @@ pay attention to the permissions of the configuration file. See
 **Authelia** can also be installed on top of [Kubernetes] using
 [nginx ingress controller](https://github.com/kubernetes/ingress-nginx).
 
-Please refer to the following [documentation](../example/kube/README.md)
+Please refer to the following [documentation](../internal/suites/example/kube/README.md)
 for more information.
 
 ## FAQ

internal/suites/BypassAll/docker-compose.yml

@@ -2,5 +2,5 @@ version: '3'
 services:
   authelia-backend:
     volumes:
-      - './internal/suites/BypassAll/configuration.yml:/etc/authelia/configuration.yml:ro'
+      - './BypassAll/configuration.yml:/etc/authelia/configuration.yml:ro'
-      - './internal/suites/BypassAll/users.yml:/var/lib/authelia/users.yml'
+      - './BypassAll/users.yml:/var/lib/authelia/users.yml'

internal/suites/Docker/docker-compose.yml

@@ -2,5 +2,5 @@ version: '3'
 services:
   authelia-backend:
     volumes:
-      - './internal/suites/Docker/configuration.yml:/etc/authelia/configuration.yml:ro'
+      - './Docker/configuration.yml:/etc/authelia/configuration.yml:ro'
-      - './internal/suites/Docker/users.yml:/var/lib/authelia/users.yml'
+      - './Docker/users.yml:/var/lib/authelia/users.yml'

internal/suites/DuoPush/docker-compose.yml

@@ -2,5 +2,5 @@ version: '3'
 services:
   authelia-backend:
     volumes:
-      - './internal/suites/DuoPush/configuration.yml:/etc/authelia/configuration.yml:ro'
+      - './DuoPush/configuration.yml:/etc/authelia/configuration.yml:ro'
-      - './internal/suites/DuoPush/users.yml:/var/lib/authelia/users.yml'
+      - './DuoPush/users.yml:/var/lib/authelia/users.yml'

internal/suites/HAProxy/docker-compose.yml

@@ -2,5 +2,5 @@ version: '3'
 services:
   authelia-backend:
     volumes:
-      - './internal/suites/HAProxy/configuration.yml:/etc/authelia/configuration.yml:ro'
+      - './HAProxy/configuration.yml:/etc/authelia/configuration.yml:ro'
-      - './internal/suites/HAProxy/users.yml:/var/lib/authelia/users.yml'
+      - './HAProxy/users.yml:/var/lib/authelia/users.yml'

internal/suites/HighAvailability/docker-compose.yml

@@ -2,4 +2,4 @@ version: '3'
 services:
   authelia-backend:
     volumes:
-      - './internal/suites/HighAvailability/configuration.yml:/etc/authelia/configuration.yml:ro'
+      - './HighAvailability/configuration.yml:/etc/authelia/configuration.yml:ro'

internal/suites/LDAP/docker-compose.yml

@@ -2,4 +2,4 @@ version: '3'
 services:
   authelia-backend:
     volumes:
-      - './internal/suites/LDAP/configuration.yml:/etc/authelia/configuration.yml:ro'
+      - './LDAP/configuration.yml:/etc/authelia/configuration.yml:ro'

internal/suites/Mariadb/docker-compose.yml

@@ -2,5 +2,5 @@ version: '3'
 services:
   authelia-backend:
     volumes:
-      - './internal/suites/Mariadb/configuration.yml:/etc/authelia/configuration.yml:ro'
+      - './Mariadb/configuration.yml:/etc/authelia/configuration.yml:ro'
-      - './internal/suites/Mariadb/users.yml:/var/lib/authelia/users.yml'
+      - './Mariadb/users.yml:/var/lib/authelia/users.yml'

internal/suites/NetworkACL/docker-compose.yml

@@ -2,5 +2,5 @@ version: '3'
 services:
   authelia-backend:
     volumes:
-      - './internal/suites/NetworkACL/configuration.yml:/etc/authelia/configuration.yml:ro'
+      - './NetworkACL/configuration.yml:/etc/authelia/configuration.yml:ro'
-      - './internal/suites/NetworkACL/users.yml:/var/lib/authelia/users.yml'
+      - './NetworkACL/users.yml:/var/lib/authelia/users.yml'

internal/suites/OneFactorDefaultPolicy/docker-compose.yml

@@ -2,5 +2,5 @@ version: '3'
 services:
   authelia-backend:
     volumes:
-      - './internal/suites/OneFactorDefaultPolicy/configuration.yml:/etc/authelia/configuration.yml:ro'
+      - './OneFactorDefaultPolicy/configuration.yml:/etc/authelia/configuration.yml:ro'
-      - './internal/suites/OneFactorDefaultPolicy/users.yml:/var/lib/authelia/users.yml'
+      - './OneFactorDefaultPolicy/users.yml:/var/lib/authelia/users.yml'

internal/suites/Postgres/docker-compose.yml

@@ -2,5 +2,5 @@ version: '3'
 services:
   authelia-backend:
     volumes:
-      - './internal/suites/Postgres/configuration.yml:/etc/authelia/configuration.yml:ro'
+      - './Postgres/configuration.yml:/etc/authelia/configuration.yml:ro'
-      - './internal/suites/Postgres/users.yml:/var/lib/authelia/users.yml'
+      - './Postgres/users.yml:/var/lib/authelia/users.yml'

internal/suites/ShortTimeouts/docker-compose.yml

@@ -2,5 +2,5 @@ version: '3'
 services:
   authelia-backend:
     volumes:
-      - './internal/suites/ShortTimeouts/configuration.yml:/etc/authelia/configuration.yml:ro'
+      - './ShortTimeouts/configuration.yml:/etc/authelia/configuration.yml:ro'
-      - './internal/suites/ShortTimeouts/users.yml:/var/lib/authelia/users.yml'
+      - './ShortTimeouts/users.yml:/var/lib/authelia/users.yml'

internal/suites/Standalone/docker-compose.yml

@@ -5,7 +5,7 @@ services:
       - AUTHELIA_JWT_SECRET=very_important_secret
       - AUTHELIA_SESSION_SECRET=unsecure_session_secret
     volumes:
-      - './internal/suites/Standalone/configuration.yml:/etc/authelia/configuration.yml:ro'
+      - './Standalone/configuration.yml:/etc/authelia/configuration.yml:ro'
-      - './internal/suites/Standalone/users.yml:/var/lib/authelia/users.yml'
+      - './Standalone/users.yml:/var/lib/authelia/users.yml'
       - '/tmp:/tmp'
     user: ${USER_ID}:${GROUP_ID}

internal/suites/Traefik/docker-compose.yml

@@ -2,5 +2,5 @@ version: '3'
 services:
   authelia-backend:
     volumes:
-      - './internal/suites/Traefik/configuration.yml:/etc/authelia/configuration.yml:ro'
+      - './Traefik/configuration.yml:/etc/authelia/configuration.yml:ro'
-      - './internal/suites/Traefik/users.yml:/var/lib/authelia/users.yml'
+      - './Traefik/users.yml:/var/lib/authelia/users.yml'

internal/suites/Traefik2/docker-compose.yml

@@ -2,5 +2,5 @@ version: '3'
 services:
   authelia-backend:
     volumes:
-      - './internal/suites/Traefik2/configuration.yml:/etc/authelia/configuration.yml:ro'
+      - './Traefik2/configuration.yml:/etc/authelia/configuration.yml:ro'
-      - './internal/suites/Traefik2/users.yml:/var/lib/authelia/users.yml'
+      - './Traefik2/users.yml:/var/lib/authelia/users.yml'

internal/suites/docker.go

@@ -30,13 +30,13 @@ func NewDockerEnvironment(files []string) *DockerEnvironment {
 }
 
 func (de *DockerEnvironment) createCommandWithStdout(cmd string) *exec.Cmd {
-	dockerCmdLine := fmt.Sprintf("docker-compose -f %s %s", strings.Join(de.dockerComposeFiles, " -f "), cmd)
+	dockerCmdLine := fmt.Sprintf("docker-compose -p authelia -f %s %s", strings.Join(de.dockerComposeFiles, " -f "), cmd)
 	log.Trace(dockerCmdLine)
 	return utils.CommandWithStdout("bash", "-c", dockerCmdLine)
 }
 
 func (de *DockerEnvironment) createCommand(cmd string) *exec.Cmd {
-	dockerCmdLine := fmt.Sprintf("docker-compose -f %s %s", strings.Join(de.dockerComposeFiles, " -f "), cmd)
+	dockerCmdLine := fmt.Sprintf("docker-compose -p authelia -f %s %s", strings.Join(de.dockerComposeFiles, " -f "), cmd)
 	log.Trace(dockerCmdLine)
 	return utils.Command("bash", "-c", dockerCmdLine)
 }

internal/suites/example/compose/nginx/backend/docker-compose.yml

@@ -2,7 +2,7 @@ version: '3'
 services:
   nginx-backend:
     build:
-      context: example/compose/nginx/backend
+      context: ./example/compose/nginx/backend
     labels:
       - 'traefik.frontend.rule=Host:home.example.com,public.example.com,secure.example.com,admin.example.com,singlefactor.example.com' # Traefik 1.x
       - 'traefik.frontend.auth.forward.address=http://authelia-backend:9091/api/verify?rd=https://login.example.com:8080/' # Traefik 1.x

internal/suites/example/kube/README.md

@@ -54,7 +54,7 @@ manual intervention.
 Given your cluster already runs a LDAP server, a Redis, a SQL database,
 a SMTP server and a nginx ingress-controller, you can deploy **Authelia**
 and update your ingress configurations. An example is provided 
-[here](./authelia).
+[here](authelia).
 
 ## Questions