|
1 | | -# social |
| 1 | +# Social |
2 | 2 |
|
3 | | -## Self hosting |
| 3 | +## About |
4 | 4 |
|
5 | | -This repository contains source code for the bot itself under [packages/bot](./packages/bot/) |
6 | | -and for its HTTP API under [packages/api](./packages/api). |
7 | | -Self hosting the API is **unsupported and not recommended**, |
8 | | -and if you plan on exposing it to the internet you'll also need an instance of the |
9 | | -base ChatSift API, which can be found in the [dashboard repo](https://github.com/chatsift/dashboard). |
10 | | -It only offers CRUD over configuration and basic data as it's mostly intended for our dashboard. |
11 | | - |
12 | | -A Docker image that can be used for running anything in this monorepo is available on DockerHub under `chatsift/social`. |
13 | | - |
14 | | ---- |
15 | | - |
16 | | -With all those notices out of the way, the [docker-compose.yml](./docker-compose.yml) file |
17 | | -is probably the easiest way to get started. |
18 | | - |
19 | | -Simply create a new file called `.env`, follow the example from [.env.example](./.env.example), |
20 | | -and then run `docker compose build && docker compose up -d`. |
21 | | - |
22 | | -Alternatively, you can run your own postgresql instance, install yarn using `npm i -g yarn`, |
23 | | -run `yarn --immutable`, build the code with `yarn build`, and start up the bot using `yarn start-bot` |
24 | | -in whatever way keeps it online (e.g. pm2). |
25 | | - |
26 | | ---- |
27 | | - |
28 | | -## Updating a self-hosted instance |
29 | | - |
30 | | -Assuming you're using Docker, you don't have to do anything special. |
31 | | -`docker compose build && docker compose up -d` |
32 | | - |
33 | | -## Contributing/working on the project |
34 | | - |
35 | | -Just about everything above, except set the `NODE_ENV` env var to `dev`. |
| 5 | +This repository has been archived. The new version of Social resides in [ChatSift/chatsift](https://github.com/ChatSift/chatsift). |
36 | 6 |
|
37 | 7 | ## Licensing |
38 | 8 |
|
39 | | -This project is lincensed under the GNU AGPLv3 license. View the full file [here](./LICENSE). |
| 9 | +This project is licensed under the GNU AGPLv3 license. View the full file [here](./LICENSE). |
0 commit comments