Skip to content

Latest commit

 

History

History
150 lines (104 loc) · 3.94 KB

README.md

File metadata and controls

150 lines (104 loc) · 3.94 KB
Raw

Soketi App Manager 📡

Simple frontend for Soketi websocket server with a intuitive user interface. Made with FilamentPHP and 💕

Soketi App Manager provides a user-friendly interface for managing your Soketi websocket applications. You can effortlessly manage multiple websocket applications, streamlining your app management process. The whole setup process is made simpler so that anyone can easily get started with the Soketi websocket server. 🚀 It currently features -

  • Dashboard to show realtime server stats and app connections.
  • Dashboard to show realtime Soketi application connections.
  • Create and manage (serve, view, edit, delete and filter) multiple Soketi applications.
  • Interactive UI for managing Soketi application webhooks.
  • Interactive UI for managing webhook headers.
  • Interactive UI for managing webhook filters.
  • Create and manage multiple users with different roles (Admin/Non-admin).
  • Documentation for client and backend integration.
  • Light and dark theme.

Support the development with a ⭐ to let others know it worked for you.

I invest a lot of time and effort in open-source. If you like this project, please consider supporting me on Ko-fi. 🙏

ko-fi

Requirements

  • PHP^8.1
  • Composer^2
  • MySQL^8|PostgreSQL^13.3
  • Redis^6
  • NodeJS^14
  • Soketi running with MySQL|PostgreSQL

Local Installation

# Clone or download the repo
git clone https://github.com/rahulhaque/soketi-app-manager-filament.git

# Go to the directory
cd soketi-app-manager-filament

# Copy .env.example to .env
# Change needed variables
cp .env.example .env

# Install dependencies
composer install

# Generate application key
php artisan key:generate

# Migrate database
php artisan migrate --seed

# Run the application
php artisan serve

# Install Soketi websocket server
npm install -g @soketi/soketi

# Run Soketi server
soketi start

Docker Installation

Some considerations -

  • Port 80 is exposed through nginx by default. Change the APP_PORT in .env before running docker compose up -d if there's conflict.
  • Nginx is configured to handle websocket requests as well. No need to expose Soketi port 6001 for websockets. Use the APP_PORT instead.
# Clone or download the repo
git clone https://github.com/rahulhaque/soketi-app-manager-filament.git

# Go to the directory
cd soketi-app-manager-filament

# Copy .env.docker.example to .env
cp .env.docker.example .env

# Change the necessary variables
nano .env

# Build the image
docker compose build

# Run the application
# Give it some time to -
# > Install composer dependencies
# > Generate application key
# > Run database migration
# Press `ctrl-c` when done
docker compose up

# Now run it in background
docker compose up -d

# Drop to application shell
docker compose exec -u soketi soketi-app-manager bash

# Seed database
php artisan db:seed

# Logout from shell
exit

# Visit application
http://localhost:APP_PORT

# Stop the application or
docker compose stop

# Stop and remove the containers
docker compose down

Credentials

Email: [email protected]
Password: password

Screenshots

  1. Login

  1. Dashboard

  1. View applications

  1. Edit application

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

License

GNU General Public License v3.0. See License File for more information.