Skip to content
This repository was archived by the owner on Sep 15, 2025. It is now read-only.
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
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
## Unreleased
## v1.6.0 (2023-10-04)

### Added
* Upgrade vue/cli-service and related packages to support node 18 ssl
* node 18 support

## v1.5.2 (2023-06-23)
Expand Down
39 changes: 38 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,43 @@ to the base apex setup.
There's also an HTML front-end using Vue (`/web`) to display popular groups and provide
fallback user profile discovery.

## Local dev
Install [mongodb](https://docs.mongodb.com/manual/installation/)

Create an `.env` file in the root directory with the following values:

```
PORT_HTTPS=8085
DOMAIN=localhost:8085
DB_URL=mongodb://localhost:27017
DB_NAME=guppe
KEY_PATH=certs/key.pem
CERT_PATH=certs/cert.pem
NODE_TLS_REJECT_UNAUTHORIZED=0
NODE_ENV=development
PROXY_MODE=0
ADMIN_SECRET=secret
```

Create a `certs` directory and generate a key pair:

```
mkdir certs
cd certs
openssl req -nodes -new -x509 -keyout key.pem -out cert.pem
```

Install packages and run the local server

```
cd web/
npm install
npm run build
cd ..
npm install
npm run start
```

## Installation

Guppe uses Docker Swarm for easy load balancing Web server replicas
Expand All @@ -56,7 +93,7 @@ docker stack deploy --compose-file docker-compose.yml guppe
Backup database:

```
docker-compose exec -T mongodb sh -c 'mongodump --archive' > guppe.dump
docker exec <MONGO CONTAINER NAME> sh -c 'mongodump --archive' > guppe.dump
```

Fetch latest code & restart server:
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "guppe",
"version": "1.5.2",
"version": "1.6.0",
"description": "Decentralized social groups with ActivityPub, NodeJS, Express, Vue, and Mongodb",
"main": "index.js",
"dependencies": {
Expand Down
Loading