kbin logo

kbin

  •  0 ratings
In category: Communication / Social Networks and Forums

About kbin

Federated content aggregator and microblogging platform.

  •   1107  
  •   0  
  •   0  
  •   0  
Github stats:
  •  Commits: 1,454  
  •   84  
  •   7  
  •  Latest commit: Feb 1, 2023  

Deploy this app to Linode with a free $100 credit!

Languages/Platforms/Technologies:
Lincenses:

More about kbin

Kbin

Maintainability Test Coverage

A reddit-like content aggregator and micro-blogging platform for the fediverse.

This is a very early beta version, and a lot of features are currently broken or in active development, such as federation.


Apps

Libraries

Getting Started

Requirements

https://symfony.com/doc/6.1/reference/requirements.html

  • PHP version: 8.1 or higher
  • GD or Imagemagick php extension
  • NGINX / Apache / Caddy
  • PostgreSQL
  • Redis (optional)
  • Mercure (optional)
  • RabbitMQ (optional)
  • Elasticsearch (optional)
  • Cardano Node, Cardano Wallet (optional)

Frontend

https://github.com/symfony/ux

$ yarn install
$ yarn build

Install with Docker

Based on https://github.com/dunglas/symfony-docker

Develop

  1. If not already done, install Docker Compose
  2. Run docker compose build --pull --no-cache to build fresh images
  3. Run docker compose up (the logs will be displayed in the current shell)
  4. Open https://app.localhost in your favorite web browser and accept the auto-generated TLS certificate
  5. Run docker compose down --remove-orphans to stop the Docker containers.
$ docker compose exec php bin/console doctrine:fixtures:load
$ docker compose exec php bin/phpunit

# Using Xdebug
# Linux / Mac
$ XDEBUG_MODE=debug docker compose up -d
# Windows
$ set XDEBUG_MODE=debug&& docker compose up -d&set XDEBUG_MODE=

Production

$ APP_ENV=dev SERVER_NAME=dev.karab.in \
APP_SECRET=acme \
CADDY_MERCURE_JWT_SECRET='!ChangeThisMercureHubJWTSecretKey!' \
POSTGRES_USER=kbin \
POSTGRES_PASSWORD=acme \
POSTGRES_DB=kbin \
CADDY_MERCURE_URL="https://example.com/.well-known/mercure" \
KBIN_DEFAULT_LANG=pl \
docker compose -f docker-compose.yml -f docker-compose.prod.yml up -d

Deploying on Multiple Nodes

If you want to deploy your app on a cluster of machines, you can use Docker Swarm, which is compatible with the provided Compose files.

Configuration

Admin user

# Create new user (without email verification)
$ docker compose exec php bin/console kbin:user:create username email@exmple.com password
# Grant administrator privileges
$ docker compose exec php bin/console kbin:user:admin username

Media

$ mkdir public/media
$ chmod 755 public/media
$ chown 82:82 public/media

Elasticsearch

$ docker compose exec php bin/console fos:elastica:create
$ docker compose exec php bin/console fos:elastica:populate

JWT keys

// @todo 

Next, set up your instance https://localhost/admin

Backup and restore

Database

# Backup
$ docker exec -it database pg_dump -U symfony app > dump_`date +%d-%m-%Y"_"%H_%M_%S`.sql
# Restore
$ docker compose exec -T database psql -U symfony app < dump.sql

Images

// @todo rsync

Troubleshooting

Editing Permissions on Linux

If you work on linux and cannot edit some of the project files right after the first installation, you can run docker compose run --rm php chown -R $(id -u):$(id -g) . to set yourself as owner of the project files that were created by the docker container.

Logs

$ docker compose logs -f
$ docker compose exec php tail var/log/prod.log

Cache

$ docker compose exec php bin/console cache:clear

Federation

Official Documents

Unofficial Sources

Documentation

Sponsors and partners

blackfire.io

JetBrains

Contributing

License

AGPL-3.0 license

Comments (0)

Please login to join the discussion on this project.

kbin Reviews (0)

Overall Rating

None

based on 0 ratings

Please login to review this project.

No reviews for this project yet.

↑ back to top

Linux VPS from $11/yr.
RackNerd VPS for $11.38/mo

Popular Projects

FluxBB

in Social Networks and Forums
 31k    0    0    0  

Nextcloud

in File Transfer & Synchronization
 19k    1    1    0  

Libreddit

in Social Networks and Forums
 6k    0    1    0  

CasaOS

in Self-hosting Solutions
 5k    0    0    0  

Audiobookshelf

in Audio Streaming
 5k    0    1    0  

Mediagoblin

in Photo and Video Galleries
 4k    0    0    0  

Dashboard

in Personal Dashboards
 4k    0    0    0  

Most Discussed

Nextcloud

in File Transfer & Synchronization
 19k    1    1    0  

Tube Archivist

in Automation
 3k    0    1    0  

OneDev

in Project Management
 2k    0    0    0  

iodine

in Proxy
 2k    0    0    0  

Alf.io

in Booking and Scheduling
 2k    0    0    0  

sysPass

in Password Managers
 929    0    0    0  

Misskey

in Social Networks and Forums
 2k    0    0    0  
pCloud Lifetime

Top Rated Projects

Gitea

 1 rating
in Project Management

Bagisto

 1 rating
in E-commerce

LinkAce

 1 rating
in Bookmarks and Link Sharing

Pydio

 1 rating
in File Transfer & Synchronization

Audiobookshelf

 1 rating
in Audio Streaming

Nextcloud

 1 rating
in File Transfer & Synchronization

Seafile

 1 rating
in File Transfer & Synchronization

Categories

You May Also Be Interested In

Commento logo
Commento cover

Commento

Commento is a discussion platform that you can embed on you…

Zusam logo
Zusam cover

Zusam

Free and open-source way to self-host private forums for gr…

Scoold logo
Scoold cover

Scoold

Stack Overflow in a JAR. An enterprise-ready Q&A platform w…