diff --git a/backend/src/email/register.template.html b/backend/src/email/register.template.html index e40c47dcb..f56054add 100644 --- a/backend/src/email/register.template.html +++ b/backend/src/email/register.template.html @@ -1,5 +1,214 @@ -
Hello {{name}}!
-

-
Please click on the email below to validate your email and start using Retrospected right away.
-

-
{{domain}}/validate?email={{email}}&code={{code}}
\ No newline at end of file + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/backend/src/email/reset-password.template.html b/backend/src/email/reset-password.template.html index 822d20981..42da5e1ac 100644 --- a/backend/src/email/reset-password.template.html +++ b/backend/src/email/reset-password.template.html @@ -1,5 +1,225 @@ -
Hi {{name}},
-

-
To reset your password, follow the link:
-

-
{{domain}}/reset?email={{email}}&code={{code}}
\ No newline at end of file + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/backend/src/email/self-hosted.template.html b/backend/src/email/self-hosted.template.html index c62eed7de..0d0c7039b 100644 --- a/backend/src/email/self-hosted.template.html +++ b/backend/src/email/self-hosted.template.html @@ -1,321 +1,423 @@ - - - - - -

Hello {{name}}!

- -

- Thank you so much for purchasing a Self-Hosted licence of Retrospected. -

- -

- You can now use Retrospected on your premises, by using the key below: -

- -
{{key}}
- -
-

Quick Start

-

- You can be up and running in 5 minutes by using your personalised - docker-compose file below.
- Alternatively, if you would like to customise it or get more details - about the installation, please visit our - documentation website.
- You will also find useful information about - backup, - database management, etc. -

-
- -

- -
- -

Quick Start

- -

- You'll be up and running in no time. Your - docker-compose.yml file is ready to go. -

- -
-

1 - Prerequisites

- -

- Install - Docker and - Docker Compose. -

-
- -
-

2 - Install your docker-compose file

- -
    -
  1. - Create an empty docker-compose.yml file -
  2. -
  3. - Copy the content at the end of this email, and paste it in that file - you created. -
  4. -
  5. - - Optional: Change the various passwords, ports and other - settings. -
  6. -
  7. - In the same directory, do - docker-compose up -d -
  8. -
  9. You're done!
  10. -
-
-

Warning

-

- If you wish to change the default passwords, it is very important that - you change them - BEFORE running docker-compose for the first time. Once run, all - passwords are set and modifying them later on will not work (it will - actually fail to run). -

-
-
- -
-

3 - Enjoy!

- -

- Retrospected is now running, on the port defined in your - docker-compose.yml file (1800 by default). -

-

- You can also access - PGAdmin, which will give you access to your database. PGAdmin is available on - port 1801 (by default), and you can use the following credentials if you - didn't modify the defaults: -

- -

- If you want more configuration options, have a look at our - docker-compose.yml - editor here. -

-
- -

Let us know if you have any issue, we'll be happy to help!

-

The Retrospected Team

- - - -

Your docker-compose.yml file:

- - -
version: '3'
-services:
-  postgres:
-    image: postgres:11.6
-    hostname: postgres
-    environment:
-      # Only change the Database password below BEFORE running for the first time. Once the database
-      # is initialised, you can't change the password anymore.
-      # This password has to be the same as the DB_PASSWORD in the "backend" section below.
-      POSTGRES_PASSWORD: {{dbPassword}}
-
-      # -- Dot not modify --
-      POSTGRES_USER: postgres
-      POSTGRES_DB: retroboard
-    volumes:
-      - database:/var/lib/postgresql/data
-    restart: unless-stopped
-    logging:
-      driver: 'json-file'
-      options:
-        max-size: '50m'
-
-  backend:
-    image: antoinejaussoin/retro-board-backend:latest
-    depends_on:
-      - redis
-    environment:
-      LICENCE_KEY: {{key}} # Your personal licence key
-      SELF_HOSTED_ADMIN: '{{email}}' # This is the user who is going to be admin on the self-hosted Retrospected instance.
-      DB_PASSWORD: {{dbPassword}} # Must be the same as POSTGRES_PASSWORD above
-      SESSION_SECRET: {{sessionSecret}} # This can be anything. You don't have to change this.
-
-    restart: unless-stopped
-    logging:
-      driver: 'json-file'
-      options:
-        max-size: '50m'
-
-  pgadmin:
-    image: dpage/pgadmin4:4.15 # use biarms/pgadmin4 on ARM
-    depends_on:
-      - postgres
-    ports:
-      - '1801:80' # Change 1801 to whatever port you want to access pgAdmin from
-    environment:
-      PGADMIN_DEFAULT_EMAIL: '{{email}}' # This will give you access to PGAdmin to manage your database
-      PGADMIN_DEFAULT_PASSWORD: {{pgAdminPassword}} # Your default password. Change this if you want, but BEFORE running for the first time.
-    volumes:
-      - pgadmin:/var/lib/pgadmin
-    restart: unless-stopped
-    logging:
-      driver: 'json-file'
-      options:
-        max-size: '50m'
-
-  frontend:
-    image: antoinejaussoin/retro-board-frontend:latest
-    depends_on:
-      - backend
-    ports:
-      - '1800:80' # Change 1800 to whatever port you want to access Retrospected from
-    restart: unless-stopped
-    logging:
-      driver: 'json-file'
-      options:
-        max-size: '50m'
-
-  redis:
-    image: redis:latest
-    depends_on:
-      - postgres
-    restart: unless-stopped
-    logging:
-      driver: 'json-file'
-      options:
-        max-size: '50m'
-
-volumes:
-  database:
-  pgadmin:
- - - - - - + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/backend/src/email/self-hosted.template.original.html b/backend/src/email/self-hosted.template.original.html new file mode 100644 index 000000000..18aba547b --- /dev/null +++ b/backend/src/email/self-hosted.template.original.html @@ -0,0 +1,322 @@ + + + + + +

Hello {{name}}!

+ +

+ Thank you so much for purchasing a Self-Hosted licence of Retrospected. +

+ +

+ You can now use Retrospected on your premises, by using the key below: +

+ +
{{key}}
+ +
+

Quick Start

+

+ You can be up and running in 5 minutes by using your personalised + docker-compose file below.
+ Alternatively, if you would like to customise it or get more details + about the installation, please visit our + documentation website.
+ You will also find useful information about + backup, + database management, etc. +

+
+ +

+ +
+ +

Quick Start

+ +

+ You'll be up and running in no time. Your + docker-compose.yml file is ready to go. +

+ +
+

1 - Prerequisites

+ +

+ Install + Docker and + Docker Compose. +

+
+ +
+

2 - Install your docker-compose file

+ +
    +
  1. + Create an empty docker-compose.yml file +
  2. +
  3. + Copy the content at the end of this email, and paste it in that file + you created. +
  4. +
  5. + + Optional: Change the various passwords, ports and other + settings. +
  6. +
  7. + In the same directory, do + docker-compose up -d +
  8. +
  9. You're done!
  10. +
+
+

Warning

+

+ If you wish to change the default passwords, it is very important that + you change them + BEFORE running docker-compose for the first time. Once run, all + passwords are set and modifying them later on will not work (it will + actually fail to run). +

+
+
+ +
+

3 - Enjoy!

+ +

+ Retrospected is now running, on the port defined in your + docker-compose.yml file (1800 by default). +

+

+ You can also access + PGAdmin, which will give you access to your database. PGAdmin is available on + port 1801 (by default), and you can use the following credentials if you + didn't modify the defaults: +

+ +

+ If you want more configuration options, have a look at our + docker-compose.yml + editor here. +

+
+ +

Let us know if you have any issue, we'll be happy to help!

+

The Retrospected Team

+ + + +

Your docker-compose.yml file:

+ + +
version: '3'
+services:
+  postgres:
+    image: postgres:11.6
+    hostname: postgres
+    environment:
+      # Only change the Database password below BEFORE running for the first time. Once the database
+      # is initialised, you can't change the password anymore.
+      # This password has to be the same as the DB_PASSWORD in the "backend" section below.
+      POSTGRES_PASSWORD: {{dbPassword}}
+
+      # -- Dot not modify --
+      POSTGRES_USER: postgres
+      POSTGRES_DB: retroboard
+    volumes:
+      - database:/var/lib/postgresql/data
+    restart: unless-stopped
+    logging:
+      driver: 'json-file'
+      options:
+        max-size: '50m'
+
+  backend:
+    image: antoinejaussoin/retro-board-backend:latest
+    depends_on:
+      - redis
+    environment:
+      LICENCE_KEY: {{key}} # Your personal licence key
+      SELF_HOSTED_ADMIN: '{{email}}' # This is the user who is going to be admin on the self-hosted Retrospected instance.
+      DB_PASSWORD: {{dbPassword}} # Must be the same as POSTGRES_PASSWORD above
+      SESSION_SECRET: {{sessionSecret}} # This can be anything. You don't have to change this.
+
+    restart: unless-stopped
+    logging:
+      driver: 'json-file'
+      options:
+        max-size: '50m'
+
+  pgadmin:
+    image: dpage/pgadmin4:4.15 # use biarms/pgadmin4 on ARM
+    depends_on:
+      - postgres
+    ports:
+      - '1801:80' # Change 1801 to whatever port you want to access pgAdmin from
+    environment:
+      PGADMIN_DEFAULT_EMAIL: '{{email}}' # This will give you access to PGAdmin to manage your database
+      PGADMIN_DEFAULT_PASSWORD: {{pgAdminPassword}} # Your default password. Change this if you want, but BEFORE running for the first time.
+    volumes:
+      - pgadmin:/var/lib/pgadmin
+    restart: unless-stopped
+    logging:
+      driver: 'json-file'
+      options:
+        max-size: '50m'
+
+  frontend:
+    image: antoinejaussoin/retro-board-frontend:latest
+    depends_on:
+      - backend
+    ports:
+      - '1800:80' # Change 1800 to whatever port you want to access Retrospected from
+    restart: unless-stopped
+    logging:
+      driver: 'json-file'
+      options:
+        max-size: '50m'
+
+  redis:
+    image: redis:latest
+    depends_on:
+      - postgres
+    restart: unless-stopped
+    logging:
+      driver: 'json-file'
+      options:
+        max-size: '50m'
+
+volumes:
+  database:
+  pgadmin:
+ + + + + + + \ No newline at end of file diff --git a/backend/src/index.ts b/backend/src/index.ts index 602daf4a4..1bb15b983 100644 --- a/backend/src/index.ts +++ b/backend/src/index.ts @@ -553,6 +553,15 @@ db().then(() => { } }); + // app.get('/api/test', async (req, res) => { + // await sendSelfHostWelcome( + // 'antoine@jaussoin.com', + // 'Antoine J', + // 'BLAH-BLAH-BLAH' + // ); + // res.send('done'); + // }); + setupSentryErrorHandler(app); });