- new blog cms
This commit is contained in:
Ty Clifford
@@ -1,92 +1,55 @@
|
||||
# [Bludit](https://www.bludit.com/)
|
||||
# Neon Notes CMS
|
||||
|
||||
[](README.md)
|
||||
[](README.es.md)
|
||||
[](README.ar.md)
|
||||
[](README.zh.md)
|
||||
[](README.fr.md)
|
||||
[](README.de.md)
|
||||
[](README.hi.md)
|
||||
[](README.ja.md)
|
||||
[](README.pt.md)
|
||||
[](README.ru.md)
|
||||
Neon Notes is a small PHP blog CMS with a Bludit-style content layout:
|
||||
|
||||
Bludit the Simple, Fast, and Flexible CMS.
|
||||
```text
|
||||
bl-content/pages/<slug>/index.txt
|
||||
```
|
||||
|
||||
With Bludit, you can build your own website or blog in just seconds. It’s completely free, open-source, and easy to use. Bludit stores content in JSON format, eliminating the need for database installation or configuration. All you need is a web server with PHP support.
|
||||
|
||||
As a Flat-File CMS, Bludit offers unparalleled flexibility and speed. Plus, with support for both Markdown and HTML code, creating and managing content has never been easier.
|
||||
|
||||
## Resources
|
||||
|
||||
- [Plugins](https://plugins.bludit.com)
|
||||
- [Themes](https://themes.bludit.com)
|
||||
- [Documentation](https://docs.bludit.com)
|
||||
- News and announcement on [Twitter](https://twitter.com/bludit), [Facebook](https://www.facebook.com/bluditcms), and [Reddit](https://www.reddit.com/r/bludit/)
|
||||
- Talk & Chat on [Discord](https://discord.gg/CFaXEdZWds)
|
||||
- Help and Support on [Forum](https://forum.bludit.org)
|
||||
- Bugs reports on [Github Issues](https://github.com/bludit/bludit/issues)
|
||||
Posts and static pages are Markdown `.txt` files with front matter. Comments are stored in SQLite, site configuration and generated indexes are JSON, and visit stats are CSV for easy Excel import.
|
||||
|
||||
## Requirements
|
||||
|
||||
- Webserver with PHP support.
|
||||
- PHP v8.0 or higher version.
|
||||
- PHP [mbstring](http://php.net/manual/en/book.mbstring.php) module for full UTF-8 support.
|
||||
- PHP [gd](http://php.net/manual/en/book.image.php) module for image processing.
|
||||
- PHP [dom](http://php.net/manual/en/book.dom.php) module for DOM manipulation.
|
||||
- PHP [json](http://php.net/manual/en/book.json.php) module for JSON manipulation.
|
||||
- PHP 8.1 or newer
|
||||
- PDO SQLite enabled
|
||||
- Apache with `mod_rewrite` for `.htaccess` pretty URLs, or the PHP built-in server for local testing
|
||||
|
||||
## Installation
|
||||
|
||||
1. Download the latest version from the official page: [Bludit.com](https://www.bludit.com)
|
||||
2. Extract the zip file into a directory, such as `bludit`.
|
||||
3. Upload the `bludit` directory to your web server or hosting.
|
||||
4. Visit your domain (e.g., https://example.com/bludit/).
|
||||
5. Follow the Bludit Installer to set up your website.
|
||||
|
||||
> **Note — running behind Cloudflare, nginx, Apache or another reverse proxy:** Bludit reads the client IP from `REMOTE_ADDR` only. Proxy headers like `X-Forwarded-For` or `CF-Connecting-IP` are **not** trusted at the PHP layer because any client can forge them. If your site sits behind a reverse proxy, configure the webserver to rewrite `REMOTE_ADDR` to the real client IP before PHP sees it — otherwise the login brute-force blocklist will block the proxy itself (locking out every visitor after enough failed logins) and visitor statistics will count all traffic as a single visitor.
|
||||
>
|
||||
> - **Apache** — enable [`mod_remoteip`](https://httpd.apache.org/docs/current/mod/mod_remoteip.html) and list your upstream's IP ranges with `RemoteIPTrustedProxy`. For Cloudflare, use the header `CF-Connecting-IP` and the IP ranges published at [cloudflare.com/ips-v4](https://www.cloudflare.com/ips-v4) and [cloudflare.com/ips-v6](https://www.cloudflare.com/ips-v6).
|
||||
> - **nginx** — use the built-in [`ngx_http_realip_module`](https://nginx.org/en/docs/http/ngx_http_realip_module.html) with `set_real_ip_from` + `real_ip_header`.
|
||||
>
|
||||
> No configuration is needed for direct / localhost / intranet deployments.
|
||||
|
||||
## Quick installation for testing
|
||||
|
||||
You can use PHP Built-in web server (`php -S localhost:8000`) or Docker:
|
||||
## Local Server
|
||||
|
||||
```bash
|
||||
docker pull bludit/docker:latest
|
||||
docker run -d --name bludit -p 8000:80 bludit/docker:latest
|
||||
php -S 127.0.0.1:8080 router.php
|
||||
```
|
||||
|
||||
Then open http://localhost:8000
|
||||
## CLI
|
||||
|
||||
## Upgrading Bludit
|
||||
```bash
|
||||
php cli/blog.php help
|
||||
php cli/blog.php list --all
|
||||
php cli/blog.php create "New Post" --status=published --category=Notes --tags=php,markdown
|
||||
php cli/blog.php update hello-neon --title="Hello Neon"
|
||||
php cli/blog.php delete old-slug
|
||||
php cli/blog.php rebuild
|
||||
```
|
||||
|
||||
The following steps are valid for upgrading to any version of Bludit from the same major version. The major version is the first digit in the version number, for example, Bludit v3.x.
|
||||
## Comments
|
||||
|
||||
1. **Make a full backup**, no discussion here, entire backup of the files and directories. That means copy ALL files into a new folder.
|
||||
2. **Remember which version of Bludit you are using** for a possible roll-back.
|
||||
3. **Download the latest version** from the [official page](https://www.bludit.com).
|
||||
4. **Extract the zip file**.
|
||||
5. **Replace existing files** with the new files.
|
||||
6. **Clean your browser cache**, and please read the note below.
|
||||
7. **Log into the admin area** and check your settings.
|
||||
8. Done.
|
||||
Comments are moderated by default and protected by captcha plus a honeypot field.
|
||||
|
||||
> **Note:** If your website is behind some kind of server cache system (for example, Cloudflare provides one by default) you need to purge the files there, too. It's also a good idea to clear your browser cache. Bludit tries to reload the files with the new ones, but some components like TinyMCE may not reload, and provoke some issues in the UI or throw out JavaScript errors.
|
||||
```bash
|
||||
php cli/blog.php comments:list --status=pending
|
||||
php cli/blog.php comments:approve 1
|
||||
php cli/blog.php comments:spam 2
|
||||
php cli/blog.php comments:delete 3
|
||||
```
|
||||
|
||||
## Support Bludit
|
||||
## Stats
|
||||
|
||||
Bludit is open-source and free to use, but if you find the project useful and would like to support its development, you can contribute on [Patreon](https://www.patreon.com/join/bludit). As a token of our appreciation, supporters will receive Bludit PRO.
|
||||
Visits are appended to `storage/stats/visits.csv` with a header row suitable for spreadsheet import.
|
||||
|
||||
If you prefer, you can also make a one-time donation to buy us a coffee or beer. Every contribution helps us continue to improve Bludit and provide the best possible experience for our users.
|
||||
```bash
|
||||
php cli/blog.php stats:summary
|
||||
```
|
||||
|
||||
- [PayPal](https://www.paypal.me/bludit/10)
|
||||
- BTC (Bitcoin): [bc1qtets5pdj73uyysjpegfh2gar4pfywra4rglcph](https://www.blockchain.com/explorer/addresses/btc/bc1qtets5pdj73uyysjpegfh2gar4pfywra4rglcph)
|
||||
- ETH (Ethereum): [0x0d7D58D848aA5f175D75Ce4bC746bAC107f331b7](https://www.blockchain.com/explorer/addresses/eth/0x0d7D58D848aA5f175D75Ce4bC746bAC107f331b7)
|
||||
## Apache
|
||||
|
||||
## License
|
||||
|
||||
Bludit is open source software licensed under the [MIT license](https://tldrlegal.com/license/mit-license).
|
||||
The included `.htaccess` enables pretty URLs and blocks direct access to app code, configuration, SQLite, CSV, JSON databases, and Markdown content files.
|
||||
|
||||
Reference in New Issue
Block a user