Merge branches 'develop' and 'develop' of github.com:thedevs-network/kutt into develop

Author: poeti8

README.md

@@ -60,20 +60,33 @@ If you're coming from v1, refer to [MIGRATION.md](MIGRATION.md) to migrate data
 
 ## Setup
 
+### Manual
+
 You need to have [Node.js](https://nodejs.org/), [PostgreSQL](https://www.postgresql.org/) and [Redis](https://redis.io/) installed.
 
-1. Clone this repository or [download zip](https://github.com/thedevs-network/kutt/archive/v2-beta.zip).
-2. Copy `.example.env` to `.env` and fill it properly.
+1. Clone this repository or [download the latest zip](https://github.com/thedevs-network/kutt/releases).
+2. Copy `.example.env` to `.env` and fill it properly ([see below](#configuration)).
 3. Install dependencies: `npm install`.
 4. Run for development: `npm run dev`.
 5. Run for production: `npm run build` then `npm start`.
 
 ### Docker
 
-You need to run the app with the required envrironment variables listed in [.example.env](https://github.com/thedevs-network/kutt/blob/develop/.example.env). 
+Download the `docker-compose.yml` and the `.docker.env`-file from the repository and configure the `.docker.env` ([see below](#configuration)). 
+To execute Kutt you simply have to run `docker-compose up -d` command and then the app should be ready on port "3000".
+
+The `docker-compose.yml` uses the official kutt docker image available on [Docker Hub](https://hub.docker.com/r/kutt/kutt).
+
+### Configuration
+
+For the minimal configuration the following settings have to be changed in the `.env`-file:
 
-* [Official Docker hub image](https://hub.docker.com/r/kutt/kutt). 
-* Or simply run `docker-compose up` command and then the app should be ready on port "3000".
+- **DEFAULT_DOMAIN**: The domain of your kutt instance
+- **DB_**: The DB credentials (when you use docker-compose you can skip these)
+- **ADMIN_EMAILS**: A comma-separated list of the administrator-accounts
+- **RECAPTCHA_**: Enter your credentials to use reCaptchas or delete this setting if you don't want to use it
+- **MAIL_**: Enter the SMTP-server's credentials (The experience shows SSL works better than STARTTLS; The mail config is required to easily create accounts, see [this comment](https://github.com/thedevs-network/kutt/issues/269#issuecomment-628604256) how it can be done manually)
+- **REPORT_EMAIL**: Kutt offers a form to report malicious links which are sent to this mail-address
 
 ## Browser Extensions
 

client/helpers/analytics.ts

@@ -1,5 +1,7 @@
 import getConfig from "next/config";
 import ReactGA from "react-ga";
+import * as Sentry from '@sentry/react';
+import { Integrations } from '@sentry/apm';
 
 const { publicRuntimeConfig } = getConfig();
 
@@ -12,6 +14,19 @@ export const logPageView = () => {
   ReactGA.pageview(window.location.pathname);
 };
 
+export const initSentry = () => {
+  if (publicRuntimeConfig.SENTRY_PUBLIC_DSN) {
+    Sentry.init({
+      dsn: publicRuntimeConfig.SENTRY_PUBLIC_DSN,
+      environment: process.env.NODE_ENV,
+      integrations: [
+        new Integrations.Tracing(),
+      ],
+      tracesSampleRate: 1.0,
+    });
+  };
+};
+
 export const logEvent = (category = "", action = "") => {
   if (category && action) {
     ReactGA.event({ category, action });

client/pages/_app.tsx

@@ -7,13 +7,17 @@ import cookie from "js-cookie";
 import Head from "next/head";
 import React from "react";
 
-import { initGA, logPageView } from "../helpers/analytics";
+import { initGA, logPageView , initSentry } from "../helpers/analytics";
 import { initializeStore } from "../store";
 import { TokenPayload } from "../types";
 
 const isProd = process.env.NODE_ENV === "production";
 const { publicRuntimeConfig } = getConfig();
 
+if (isProd) {
+  initSentry();
+};
+
 // TODO: types
 class MyApp extends App<any> {
   static async getInitialProps({ Component, ctx }: AppContext) {

next.config.js

@@ -9,6 +9,7 @@ module.exports = {
     GOOGLE_ANALYTICS: localEnv && localEnv.GOOGLE_ANALYTICS,
     REPORT_EMAIL: localEnv && localEnv.REPORT_EMAIL,
     DISALLOW_ANONYMOUS_LINKS: localEnv && localEnv.DISALLOW_ANONYMOUS_LINKS,
-    DISALLOW_REGISTRATION: localEnv && localEnv.DISALLOW_REGISTRATION
+    DISALLOW_REGISTRATION: localEnv && localEnv.DISALLOW_REGISTRATION,
+    SENTRY_PUBLIC_DSN: localEnv && localEnv.SENTRY_PUBLIC_DSN,
   }
 };

package-lock.json

@@ -35,6 +35,9 @@
   },
   "homepage": "https://github.com/TheDevs-Network/kutt#readme",
   "dependencies": {
+    "@sentry/apm": "^5.21.1",
+    "@sentry/node": "^5.21.1",
+    "@sentry/react": "^5.21.1",
     "axios": "^0.19.1",
     "babel-plugin-inline-react-svg": "^1.1.0",
     "bcryptjs": "^2.4.3",
@@ -74,7 +77,6 @@
     "prop-types": "^15.7.2",
     "qrcode.react": "^0.8.0",
     "query-string": "^6.10.1",
-    "raven": "^2.6.4",
     "react": "^16.12.0",
     "react-copy-to-clipboard": "^5.0.2",
     "react-dom": "^16.12.0",

package.json

@@ -40,7 +40,8 @@ const env = cleanEnv(process.env, {
   MAIL_PASSWORD: str(),
   REPORT_EMAIL: str({ default: "" }),
   CONTACT_EMAIL: str({ default: "" }),
-  RAVEN_DSN: str({ default: "" })
+  SENTRY_PRIVATE_DSN: str({ default: "" }),
+  SENTRY_PUBLIC_DSN: str({ default: "" })
 });
 
 export default env;