Skip to content

Commit 0a2f295

Browse files
authored
Add the documentation how to configure Kutt (thedevs-network#368)
* Add a the documentation how to configure Kutt * Added link to official docker hub image * Fix typo
1 parent f7c191f commit 0a2f295

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

README.md

+18-5
Original file line numberDiff line numberDiff line change
@@ -60,20 +60,33 @@ If you're coming from v1, refer to [MIGRATION.md](MIGRATION.md) to migrate data
6060

6161
## Setup
6262

63+
### Manual
64+
6365
You need to have [Node.js](https://nodejs.org/), [PostgreSQL](https://www.postgresql.org/) and [Redis](https://redis.io/) installed.
6466

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)).
6769
3. Install dependencies: `npm install`.
6870
4. Run for development: `npm run dev`.
6971
5. Run for production: `npm run build` then `npm start`.
7072

7173
### Docker
7274

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:
7483

75-
* [Official Docker hub image](https://hub.docker.com/r/kutt/kutt).
76-
* 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
7790

7891
## Browser Extensions
7992

0 commit comments

Comments
 (0)