Sign inSign up

sbrse/chatwave

By sbrse

•Updated over 1 year ago

Modern, Simple and Secure REST API for self-hosted messanger

Image
API management
Web servers
Content management system
0

1.0K

sbrse/chatwave repository overview

⁠What is ChatWave?

Modern, Simple and Secure REST API for self-hosted messanger with open source code and GPLv3 license! This repository contains only the backend written in python 3.11 and FastAPI.

⁠How to use this image?

At the moment, the frontend has not been created, so you can wait for the official release of the web application or help with this. To help in the development of the project, you can support the repository here:

⁠How to install this image?

The application requires postgres 13 and redis to work, so if you choose Standalone method, you will need to install these dependencies yourself. If you select the All in one option, you need to run docker-compose in cloned direcory, and you should also have the .env file in this folder. To configure the env parameters, read "ENV configuration".

  1. Standalone:
docker run --name chatwave --network=host -d -p <PORT>:8000 -v chatwave_appdata:/app/data --env-file <PATH-TO-ENV> sbrse/chatwave:latest
  1. All in one:
git clone https://github.com/lifufkd/ChatWave
cd ChatWave
docker-compose up -d

⁠ENV configuration

  • Parameters for the Standalone installation method:
DB_HOST=<DOMAIN-OR-IP>
DB_USER=<USER>
DB_PASSWORD=<PASSWORD>
REDIS_HOST=<DOMAIN-OR-IP>
MEDIA_FOLDER=<PATH> # Must be same in run command (-v chatwave_appdata:/app/data)
 
# Optionaly
DB_DATABASE=<DATABASE-NAME>
REDIS_PORT=<PORT>
DB_PORT=<PORT>
DB_SCHEMA=chatwave
REDIS_DATABASE=0
REDIS_USER=<USER>
REDIS_PASSWORD=<PASSWORD>
JWT_SECRET_KEY=09d25e094faa6ca2556c818166b7a9563b93f7099f6f0f4caa6cf63b88e8d3e7 # 256 bit random string
JWT_ACCESS_TOKEN_EXPIRES=1209600 # Token expire time in seconds
JWT_ALGORITHM=HS256
CHUNK_SIZE=16 # Decimal value in MB for streaming video
MAX_UPLOAD_IMAGE_SIZE=30 # Decimal value in MB
MAX_UPLOAD_VIDEO_SIZE=8192 # Decimal value in MB
MAX_UPLOAD_AUDIO_SIZE=512 # Decimal value in MB
MAX_UPLOAD_FILE_SIZE=16384 # Decimal value in MB
MAX_ITEMS_PER_REQUEST=100 # Decimal value
  • Parameters for the All in one installation method:
# Optionaly
DB_USER=<USER>
DB_PASSWORD=<PASSWORD>
DB_DATABASE=<DATABASE-NAME>
DB_SCHEMA=chatwave
MEDIA_FOLDER=<PATH>
REDIS_USER=<USER>
REDIS_PASSWORD=<PASSWORD>
REDIS_DATABASE=0
JWT_SECRET_KEY=09d25e094faa6ca2556c818166b7a9563b93f7099f6f0f4caa6cf63b88e8d3e7 # 256 bit random string
JWT_ACCESS_TOKEN_EXPIRES=1209600 # Token expire time in seconds
JWT_ALGORITHM=HS256
CHUNK_SIZE=16 # Decimal value in MB for streaming video
MAX_UPLOAD_IMAGE_SIZE=30 # Decimal value in MB
MAX_UPLOAD_VIDEO_SIZE=8192 # Decimal value in MB
MAX_UPLOAD_AUDIO_SIZE=512 # Decimal value in MB
MAX_UPLOAD_FILE_SIZE=16384 # Decimal value in MB
MAX_ITEMS_PER_REQUEST=100 # Decimal value

⁠License

View license information⁠⁠ for the software contained in this image.

Tag summary

Content type

Image

Digest

sha256:716d16d52…

Size

91.9 MB

Last updated

over 1 year ago

docker pull sbrse/chatwave