Releases: jon6fingrs/ghostboard
Better Logging!
I have updated the docker image so that nginx and python logs appear in the docker logs along with supervisor.
Ghostboard v3.4.0
Release Notes for Ghostboard v3.4.0
Release Date: February 7, 2025
New Feature: REST Server Support
I am excited to announce Ghostboard v3.4.0, introducing REST API functionality to enhance text synchronization capabilities. This update simplifies how text can be updated and retrieved across boards, eliminating the need for a separate client script.
New REST API Endpoints
-
POST Request: Update text on a specific board.
- Example command:
Or:
curl -X POST "http://ghostboard-server:port" -d "text=$(cat example.txt)"
curl -X POST "http://ghostboard-server:port" -d "text=example"
- Example command:
-
GET Request: Retrieve the current text from a board.
- Example command:
Or:
curl "http://ghostboard-server:port?get_text=true" > ghostboard.txt
curl "http://ghostboard-server:port?get_text=true"
- Example command:
These REST endpoints work seamlessly with any board, dynamically determined by the URL path (e.g., /test
, /example
). This feature improves automation and integration options, enabling better interaction with Ghostboard from various devices and scripts.
Client Script Deprecation
With the addition of the REST API, the separate command-line client script has become largely obsolete. Users can now rely on standard curl
commands or other REST API tools to interact with Ghostboard, streamlining usage and integration.
websocket autoreconnect
Great suggestion by /u/PhragMunkee.
Thanks!
Visual Style Improvements
This is a fairly small release with not much change, but it addresses a few annoying visual issues.
- Previously, when scrolling down on a lot of text either in markdown mode or in text mode, the switches at the bottom of the page would get in the way and make it more difficult to access buttons at the bottom of the text box. That has been fixed and now the scrolling will continue until the buttons are above the bottom switches.
- The drag and drop green outline wasn't consistent across text mode, markdown-edit mode, and markdown-preview mode. It may not be perfect, but it's much better now than it had been.
SIMPLIFIED PORTS
I think a common issue preventing folks from using this was the fact that a websocket and webserver port are both required, it made reverse proxies more challenging than they should be.
With this release, I included nginx and if accessed through port 80 (internal ofc), all traffic will travel through that port. The container's nginx and the program will identify that they are behind nginx and use a /ws endpoint on port 80.
At the same time, I did not want to introduce a breaking change, and so, you can continue to expose ports 8080 and 8765 if they are set up and working. They will continue to work in the way that they have. They will see that they are not behind nginx and not rely on the /ws endpoint, instead accessing the necessary ports directly.
So, this hopefully does not introduce a breaking change, but let me know if it does.
MARKDOWN EDITING!
This was an awesome suggestion from /u/jack3308 over on Reddit.
Could I be SUPER selfish and ask if you have plans to provide support for markdown in a WYSIWYG (what you see is what you get) implementation? This would so quickly become my most used self hosted service if it did!!!
Yes, yes you can. The markdown editor turned out better than I had hoped. The regular ole text editor is still present, but there is now a switch at the bottom next to the dark mode switch. You can go between light mode and dark mode. The text remains the same and regardless of how you type it or how you interact with it, will always sync up.
Check it out!
Ghostboard v3.0.0 is here!
New Features & Enhancements
Nonintrusive Corner Tabs & Expansions:
- Small triangular tabs appear in the bottom corners of the page.
- Clicking a tab reveals an animated, quarter-circle expansion:
The left tab shows project information (name, author, and version).
The right tab opens a large, clickable GitHub icon linking to the project page.
- These tabs are fully integrated into the layout without interfering with text sharing functionality.
Improved Dark/Light Mode Toggle:
- Positioned at the bottom center of the page, the toggle matches the modernized design.
- Fully responsive, with animations to improve user experience.
WebSocket Connection Handling:
- If the WebSocket connection is lost, the page becomes read-only and displays a clear error message.
- Users can click a "Reload Page" link to reconnect.
minor fixes
Changed the title of the page to "Ghostboard" and made sure all buttons propogate to other instances.
open text files
added open button and drag-and-drop
Copy and Clear Buttons
Added copy and clear buttons at the bottom of the text box.