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
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,13 +49,13 @@ Support the development of Kutt by making a donation or becoming an sponsor.
49
49
50
50
## Setup
51
51
52
-
The only prerequisite is [Node.js](https://nodejs.org/) (version 20 or above). The default database is SQLite. You can optionally install Posrgres or MySQL/MariaDB for the database or Redis for the cache.
52
+
The only prerequisite is [Node.js](https://nodejs.org/) (version 20 or above). The default database is SQLite. You can optionally install Postgres or MySQL/MariaDB for the database or Redis for the cache.
53
53
54
54
When you first start the app, you're prompted to create an admin account.
55
55
56
56
1. Clone this repository or [download the latest zip](https://github.com/thedevs-network/kutt/releases)
57
57
2. Install dependencies: `npm install`
58
-
3.Intialize database: `npm run migrate`
58
+
3.Initialize database: `npm run migrate`
59
59
5. Start the app for development `npm run dev` or production `npm start`
60
60
61
61
## Docker
@@ -70,11 +70,11 @@ Various docker-compose configurations are available. Use `docker compose -f <fil
70
70
71
71
-[`docker-compose.yml`](./docker-compose.yml): Default Kutt setup. Uses SQLite for the database.
72
72
-[`docker-compose.sqlite-redis.yml`](./docker-compose.sqlite-redis.yml): Starts Kutt with SQLite and Redis.
73
-
- Required envrionment variable: `REDIS_ENABLED`
73
+
- Required environment variable: `REDIS_ENABLED`
74
74
-[`docker-compose.postgres.yml`](./docker-compose.postgres.yml): Starts Kutt with Postgres and Redis.
|`REDIS_DB`| Redis database number, between 0 and 15. |`0`|`1`|
119
119
|`SERVER_IP_ADDRESS`| The IP address shown to the user on the setting's page. It's only for display purposes and has no other use. | - |`1.2.3.4`|
120
120
|`SERVER_CNAME_ADDRESS`| The subdomain shown to the user on the setting's page. It's only for display purposes and has no other use. | - |`custom.yoursite.com`|
121
121
|`CUSTOM_DOMAIN_USE_HTTPS`| Use https for links with custom domain. It's on you to generate SSL certificates for those domains manually—at least on this version for now. |`false`|`true`|
122
-
|`ENABLE_RATE_LIMIT`| Enable rate limitting for some API routes. If Redis is enabled uses Redis, otherwise, uses memory. |`false`|`true`|
122
+
|`ENABLE_RATE_LIMIT`| Enable rate limiting for some API routes. If Redis is enabled uses Redis, otherwise, uses memory. |`false`|`true`|
123
123
|`MAIL_ENABLED`| Enable emails, which are used for signup, verifying or changing email address, resetting password, and sending reports. If is disabled, all these functionalities will be disabled too. |`false`|`true`|
124
124
|`MAIL_HOST`| Email server host | - |`your-mail-server.com`|
125
125
|`MAIL_PORT`| Email server port |`587`|`465` (SSL) |
0 commit comments