You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+18-5
Original file line number
Diff line number
Diff line change
@@ -60,20 +60,33 @@ If you're coming from v1, refer to [MIGRATION.md](MIGRATION.md) to migrate data
60
60
61
61
## Setup
62
62
63
+
### Manual
64
+
63
65
You need to have [Node.js](https://nodejs.org/), [PostgreSQL](https://www.postgresql.org/) and [Redis](https://redis.io/) installed.
64
66
65
-
1. Clone this repository or [download zip](https://github.com/thedevs-network/kutt/archive/v2-beta.zip).
66
-
2. Copy `.example.env` to `.env` and fill it properly.
67
+
1. Clone this repository or [download the latest zip](https://github.com/thedevs-network/kutt/releases).
68
+
2. Copy `.example.env` to `.env` and fill it properly ([see below](#configuration)).
67
69
3. Install dependencies: `npm install`.
68
70
4. Run for development: `npm run dev`.
69
71
5. Run for production: `npm run build` then `npm start`.
70
72
71
73
### Docker
72
74
73
-
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).
75
+
Download the `docker-compose.yml` and the `.docker.env`-file from the repository and configure the `.docker.env` ([see below](#configuration)).
76
+
To execute Kutt you simply have to run `docker-compose up -d` command and then the app should be ready on port "3000".
77
+
78
+
The `docker-compose.yml` uses the official kutt docker image available on [Docker Hub](https://hub.docker.com/r/kutt/kutt).
79
+
80
+
### Configuration
81
+
82
+
For the minimal configuration the following settings have to be changed in the `.env`-file:
* Or simply run `docker-compose up` command and then the app should be ready on port "3000".
84
+
-**DEFAULT_DOMAIN**: The domain of your kutt instance
85
+
-**DB_**: The DB credentials (when you use docker-compose you can skip these)
86
+
-**ADMIN_EMAILS**: A comma-separated list of the administrator-accounts
87
+
-**RECAPTCHA_**: Enter your credentials to use reCaptchas or delete this setting if you don't want to use it
88
+
-**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)
89
+
-**REPORT_EMAIL**: Kutt offers a form to report malicious links which are sent to this mail-address
0 commit comments