Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update readme #152

Merged
merged 1 commit into from
Jun 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions .env.sample
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
KONECTY_MODE=development
MONGO_URL= #mongodb://localhost:27023/clientname?directConnection=true

DISABLE_REINDEX=true
ALLOWED_ORIGINS=http://localhost:3000|http://localhost:5173

LOG_REQUEST=true
LOG_LEVEL=trace
LOG_TO_FILE=kon.log

KONMETA_NAMESPACE= #clientname
UI_URL=https://ui.konecty.com

BLOB_URL=http://localhost:3001
PREVIEW_URL=http://localhost:3001
32 changes: 22 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,34 @@

# Konecty Open source Tech Business Platform

## How to run local/development

You will need a mongodb database (you can use a free account at cloud.mongodb.com or a local mongodb install)

Create .env using the sample.

Fill MONGO_URL with your database url, adding authentication and options

MONGO_URL=mongodb+srv://login:[email protected]/?appName=konecty


```
yarn
yarn start
```

If this is a empty database, basic metadata and starting collections will be automatically created.

The UI will be running at `localhost:3000`



## Konecty environment variables

- `KONECTY_MODE`: Can be `production` or `development`
- `DISABLE_KONSISTENT`: can be to `true` if you don't want Konsistent to run on the same process as Kondata. It's enabled by default.
- `MONGO_URL`: Mongo database URL
- `MONGO_OPLOG_URL`: Mongo database oplog URL
- `DISABLE_REINDEX`: can be to `true` if you don't want to verify if all index are created.
- `ROOT_URL`: your public url
- `ALLOWED_ORIGINS`: a list of cors alloweds URLs separated by `|`
- `LOG_REQUEST=true`: if provide all requests are loggeds
- `DEFAULT_SMTP_HOST`: SMTP host for default email sender (**required**)
Expand Down Expand Up @@ -59,11 +79,3 @@ Examples of REST usage can be found here: [REST](REST.md)
## Logs

- KONDATA only log requests when **_status code_** of the response isn't 200 (OK).

## DEVELOPMENT

```
sudo apt install build-essential
meteor npm install
meteor
```