Skip to content

Commit f172884

Browse files
authored
Fix typos and grammar issues in documentation (#855)
* Fix typos and grammar issues in documentation * Fixed Postgres name in documentation
1 parent 34d6c14 commit f172884

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -49,13 +49,13 @@ Support the development of Kutt by making a donation or becoming an sponsor.
4949

5050
## Setup
5151

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.
5353

5454
When you first start the app, you're prompted to create an admin account.
5555

5656
1. Clone this repository or [download the latest zip](https://github.com/thedevs-network/kutt/releases)
5757
2. Install dependencies: `npm install`
58-
3. Intialize database: `npm run migrate`
58+
3. Initialize database: `npm run migrate`
5959
5. Start the app for development `npm run dev` or production `npm start`
6060

6161
## Docker
@@ -70,11 +70,11 @@ Various docker-compose configurations are available. Use `docker compose -f <fil
7070

7171
- [`docker-compose.yml`](./docker-compose.yml): Default Kutt setup. Uses SQLite for the database.
7272
- [`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`
7474
- [`docker-compose.postgres.yml`](./docker-compose.postgres.yml): Starts Kutt with Postgres and Redis.
75-
- Required envrionment variables: `REDIS_ENABLED`, `DB_PASSWORD`, `DB_NAME`, `DB_USER`
75+
- Required environment variables: `REDIS_ENABLED`, `DB_PASSWORD`, `DB_NAME`, `DB_USER`
7676
- [`docker-compose.mariadb.yml`](./docker-compose.mariadb.yml): Starts Kutt with MariaDB and Redis.
77-
- Required envrionment variables: `REDIS_ENABLED`, `DB_PASSWORD`, `DB_NAME`, `DB_USER`, `DB_PORT`
77+
- Required environment variables: `REDIS_ENABLED`, `DB_PASSWORD`, `DB_NAME`, `DB_USER`, `DB_PORT`
7878

7979
Official Kutt Docker image is available on [Docker Hub](https://hub.docker.com/r/kutt/kutt).
8080

@@ -114,12 +114,12 @@ You can use files for each of the variables by appending `_FILE` to the name of
114114
| `REDIS_ENABLED` | Whether to use Redis for cache | `false` | `true` |
115115
| `REDIS_HOST` | Redis connection host | `127.0.0.1` | `your-redis-host.com` |
116116
| `REDIS_PORT` | Redis port | `6379` | `6379` |
117-
| `REDIS_PASSWORD` | Redis passowrd | - | `mypassword` |
117+
| `REDIS_PASSWORD` | Redis password | - | `mypassword` |
118118
| `REDIS_DB` | Redis database number, between 0 and 15. | `0` | `1` |
119119
| `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` |
120120
| `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` |
121121
| `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` |
123123
| `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` |
124124
| `MAIL_HOST` | Email server host | - | `your-mail-server.com` |
125125
| `MAIL_PORT` | Email server port | `587` | `465` (SSL) |

0 commit comments

Comments
 (0)