Skip to content

ChatSift/Social

Repository files navigation

social

Self hosting

This repository contains source code for the bot itself under packages/bot and for its HTTP API under packages/api. Self hosting the API is unsupported and not recommended, and if you plan on exposing it to the internet you'll also need an instance of the base ChatSift API, which can be found in the dashboard repo. It only offers CRUD over configuration and basic data as it's mostly intended for our dashboard.

A Docker image that can be used for running anything in this monorepo is available on DockerHub under chatsift/social.


With all those notices out of the way, the docker-compose.yml file is probably the easiest way to get started.

Simply create a new file called .env, follow the example from .env.example, and then run docker compose build && docker compose up -d.

Alternatively, you can run your own postgresql instance, install yarn using npm i -g yarn, run yarn --immutable, build the code with yarn build, and start up the bot using yarn start-bot in whatever way keeps it online (e.g. pm2).


Updating a self-hosted instance

Assuming you're using Docker, you don't have to do anything special. docker compose build && docker compose up -d

Contributing/working on the project

Just about everything above, except set the NODE_ENV env var to dev.

Licensing

This project is lincensed under the GNU AGPLv3 license. View the full file here.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages