Ghostboard is a lightweight, real-time text-sharing and synchronization tool built for self-hosters. Whether you need a quick way to share notes across multiple devices or maintain centralized text logs within your private network, Ghostboard offers an effortless, WebSocket-based solution with both a web interface and command-line client.
While Ghostboard is fast and efficient, it’s important to note that it lacks built-in encryption or advanced security measures. This makes it ideal for trusted environments but not for sensitive or public deployments without additional security configurations.
Why Was Ghostboard Created?
As a developer frequently moving between containers, virtual machines, and servers, simple text transfers became unnecessarily cumbersome. Workarounds like emailing notes, using Nextcloud, or relying on third-party apps felt overkill for quick text sharing. Ghostboard was created to eliminate friction and simplify text synchronization without unnecessary complexity.
Try the online read-only demo to get a feel for how it works.
Community-Driven Development
Ghostboard thrives on community feedback. One of its biggest milestones was the introduction of dark mode and markdown support, both highly requested features. Engaged users on platforms like Reddit have shaped its development, ensuring that it remains intuitive and efficient.
How Does Ghostboard Work?
Ghostboard operates on a Python-based WebSocket server, offering near-instant synchronization. Here’s how it functions:
- Server Initialization: The Ghostboard server starts, handling both HTTP requests (for the web UI & API) and WebSocket connections (for real-time updates).
- Client Connections: A web-based or command-line client connects to the server via WebSocket. Each board (e.g.,
/notes,/tasks) operates as a separate synchronized channel. - Instant Syncing: Any text update made by one client is instantly reflected across all connected devices.
- REST API Support: Users can programmatically retrieve and update text using REST API endpoints, making Ghostboard ideal for automation and scripting.
- Lightweight and Fast: Ghostboard stores text in memory, keeping operations ultra-fast. Inactive boards automatically clear their text, ensuring a clean and efficient workflow.
Features of Ghostboard
- Real-Time Text Sync – Instant updates across all connected clients.
- Multiple Boards – Unique URL paths create separate shared text spaces.
- Dark Mode & Markdown Support – Enhanced readability and formatting options.
- REST API Integration – Automate text updates and retrieval.
- Docker Support – Easy self-hosting and quick deployment.
Setting Up Ghostboard
1. Using Docker (Recommended)
Ghostboard can be quickly deployed via Docker:
docker pull thehelpfulidiot/ghostboard-server
docker run --rm -p 80:80 thehelpfulidiot/ghostboard-serverOnce running, access it via http://<server-ip>.
2. Manual Installation (Python-Based)
For users preferring a non-Docker approach:
# Clone the repository
git clone https://github.com/jon6fingrs/ghostboard.git
cd ghostboard/server
# Install dependencies
pip install -r requirements.txt
# Start the Ghostboard server
python3 get_text.pyGhostboard will now be accessible locally.
REST API: Automate Your Workflows
Ghostboard’s REST API allows seamless integration into automated systems:
Retrieve Text from a Board
curl "http://<server-ip>/notes?get_text=true"Update Text on a Board
curl -X POST "http://<server-ip>/notes" -d "text=Hello, World!"Ghostboard in Action: Screenshots
Light Mode Interface:
Dark Mode Interface:
Future Developments
Ghostboard is continuously evolving, with planned features including better WebSocket handling, UI refinements, and enhanced API capabilities. Community-driven enhancements will keep it at the forefront of self-hosted real-time text sharing.
Try Ghostboard Today!
Curious about real-time synchronized text sharing? Get started by visiting the GitHub repository. Contributions, feedback, and feature requests are always welcome!
Shared by Noted
