https://github.com/denver-code/logunit

https://github.com/denver-code/logunit

Last synced: 3 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/denver-code/logunit
• Owner: denver-code
• Created: 2023-08-11T12:44:50.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-08-13T19:21:14.000Z (over 1 year ago)
• Last Synced: 2023-08-13T20:31:01.365Z (over 1 year ago)
• Language: Python
• Size: 32.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Log Unit  

Simple RestAPI service/unit for ecosystem where all logs from other services are stored and accessible in one place.

## Downloading

```bash

git clone https://github.com/denver-code/logunit

cd logunit

```

## Activating Shell

```bash

poetry shell

```

## Installation

> **Note:** This project uses [Poetry](https://python-poetry.org/) for dependency management.

```bash

poetry install

```

Rename `sample.env` to `.env` and fill it with your data.

## Generating Keys for Encryption

```bash

python3 genrsa.py

```

This will generate `private.pem` and `public.pem` files in the root directory of the project. Store `private.pem` in a safe as it is used for decryption.  

If you will lose private key, you will lose all your logs without ability to restore them.

## Running

```bash

poetry run uvicorn app.main:app

```

## Docker

```bash

docker-compose up --build -d

```

## Api documentation

Api documentation is available at `/docs` endpoint.

But [here](API.md) is some examples.