tinyib/README.md

162 lines
8.0 KiB
Markdown
Raw Normal View History

2020-09-05 16:50:44 +00:00
# TinyIB - Lightweight and efficient [imageboard](https://en.wikipedia.org/wiki/Imageboard)
[![Translate](https://hosted.weblate.org/widgets/tinyib/-/tinyib/svg-badge.svg)](https://hosted.weblate.org/projects/tinyib/tinyib/)
[![Donate](https://img.shields.io/liberapay/receives/rocketnine.space.svg?logo=liberapay)](https://liberapay.com/rocketnine.space)
2018-07-20 18:59:29 +00:00
See [DEMOS.md](https://code.rocketnine.space/tslocum/tinyib/src/branch/master/DEMOS.md) for a list of sites running TinyIB.
2018-07-20 18:59:29 +00:00
2020-10-14 16:48:20 +00:00
## Features
2010-06-22 07:52:15 +00:00
**Got database? Get speed.** Use [MySQL](https://mysql.com), [PostgreSQL](https://www.postgresql.org) or [SQLite](https://sqlite.org) for an efficient set-up able to handle high amounts of traffic.
2010-06-22 07:52:15 +00:00
2013-04-15 01:05:08 +00:00
**No database? No problem.** Store posts as text files for a portable set-up capable of running on virtually any PHP host.
**Not looking for an image board script?** TinyIB is able to allow new threads without requiring an image, or disallow images entirely.
2014-06-24 19:51:22 +00:00
- GIF, JPG, PNG, SWF, MP4 and WebM upload.
- YouTube, Vimeo and SoundCloud embedding.
- CAPTCHA:
2020-11-10 16:17:45 +00:00
- A simple, self-hosted implementation is included.
2021-03-10 18:45:54 +00:00
- [hCaptcha](https://hcaptcha.com) is supported.
2021-03-13 08:08:23 +00:00
- [ReCAPTCHA](https://www.google.com/recaptcha/about/) is supported. (But [not recommended](https://nearcyan.com/you-probably-dont-need-recaptcha/))
2020-11-10 16:17:45 +00:00
- Reference links. `>>###`
2021-03-13 08:39:08 +00:00
- Fetch new replies automatically. (See `TINYIB_AUTOREFRESH`)
2020-11-13 20:32:42 +00:00
- Delete posts via password.
- Report posts.
- Block keywords.
2013-04-15 01:05:08 +00:00
- Management panel:
- Account system:
- Super administrators (all privileges)
- Administrators (all privileges except account management)
- Moderators (only able to sticky threads, lock threads, approve posts and delete posts)
2013-04-15 01:05:08 +00:00
- Ban offensive/abusive posters across all boards.
- Post using raw HTML.
2013-07-31 04:37:07 +00:00
- Upgrade automatically when installed via git. (Tested on Linux only)
- [Translations:](https://hosted.weblate.org/projects/tinyib/tinyib/)
2020-10-22 16:16:54 +00:00
- Chinese
2020-09-27 14:41:10 +00:00
- Dutch
2020-09-05 16:50:44 +00:00
- French
- German
2020-09-06 16:46:39 +00:00
- Italian
2020-10-22 16:16:54 +00:00
- Korean
2020-09-05 16:50:44 +00:00
- Norwegian
2021-03-13 08:25:21 +00:00
- Portuguese
2021-01-28 23:26:56 +00:00
- Russian
2020-10-14 16:50:27 +00:00
- Spanish (Mexico)
2020-12-07 18:23:58 +00:00
- Turkish
2013-04-15 01:05:08 +00:00
2020-10-14 16:48:20 +00:00
## Donate
Please consider supporting the continued development of TinyIB.
2020-12-06 01:55:13 +00:00
If you make a donation and there is a certain feature you'd like to see added to
TinyIB, <a href="mailto:trevor@rocketnine.space">send me an email</a>. I can't
promise that I will implement the feature right away, however I will keep your
support in mind.
2020-12-07 16:05:41 +00:00
- [LiberaPay](https://liberapay.com/rocketnine.space) (anonymous, no added fees)
- [PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=TEP9HT98XK7QA)
2020-10-14 16:48:20 +00:00
## Install
2010-06-22 07:52:15 +00:00
1. Verify the following are installed:
2020-11-13 20:32:42 +00:00
- [PHP 5.5+](https://php.net)
- [GD Image Processing Library](https://php.net/gd)
- This library is usually installed by default.
2014-10-28 22:12:43 +00:00
- If you plan on disabling image uploads to use TinyIB as a text board only, this library is not required.
2021-03-13 08:08:23 +00:00
- [cURL Library](https://www.php.net/manual/en/book.curl.php)
- This is recommended, but is not strictly required except when `TINYIB_CAPTCHA` is set to `hcaptcha` or `recaptcha`.
2013-04-15 01:05:08 +00:00
2. CD to the directory you wish to install TinyIB.
3. Run the command:
- `git clone https://code.rocketnine.space/tslocum/tinyib.git ./`
2013-04-15 01:05:08 +00:00
4. Copy **settings.default.php** to **settings.php**
5. Configure **settings.php**
2020-11-13 20:32:42 +00:00
- When setting ``TINYIB_DBMODE`` to ``flatfile``, note that all post, report and ban data are exposed as the database is composed of standard text files. Access to ./inc/database/flatfile/ should be denied.
- When setting ``TINYIB_DBMODE`` to ``pdo``, note that only the MySQL and PostgreSQL databases drivers have been tested. Theoretically it will work with any applicable driver, but this is not guaranteed. If you use an alternative driver, please report back.
- Field length settings require a modification to the database field to accommodate the increased length in order to take effect.
- To require moderation before displaying posts:
- Set ``TINYIB_REQMOD`` to ``files`` to require moderation for posts with files attached.
- Set ``TINYIB_REQMOD`` to ``all`` to require moderation for all posts.
- Moderate posts by visiting the management panel.
- To allow video uploads:
- Ensure your web host is running Linux.
- Install [ffmpeg](https://ffmpeg.org). On Ubuntu, run ``sudo apt-get install ffmpeg``.
- Add desired video file types to ``$tinyib_uploads``.
- To remove the play icon from .SWF and .WebM thumbnails, delete or rename **video_overlay.png**
- To use FFMPEG to create thumbnails:
- Install FFMPEG and ensure the ``ffmpeg`` and ``ffprobe`` commands are available.
- Set ``TINYIB_THUMBNAIL`` to ``ffmpeg``.
- To use ImageMagick instead of GD when creating thumbnails:
- Install ImageMagick and ensure that the ``convert`` command is available.
- Set ``TINYIB_THUMBNAIL`` to ``imagemagick``.
- **Note:** GIF files will have animated thumbnails, which will often have large file sizes.
- To use TINYIB in another language:
- Set ``TINYIB_LOCALE`` to a language code found in `locale/`.
2020-09-03 02:05:36 +00:00
- Ensure you are running PHP 5.4+.
6. [CHMOD](https://en.wikipedia.org/wiki/Chmod) write permissions to these directories:
2013-04-15 01:05:08 +00:00
- ./ (the directory containing TinyIB)
2012-05-18 07:37:50 +00:00
- ./src/
- ./thumb/
- ./res/
- ./inc/database/flatfile/ (only if you use the ``flatfile`` database mode)
2013-04-16 01:20:08 +00:00
7. Navigate your browser to **imgboard.php** and the following will take place:
2013-04-15 01:05:08 +00:00
- The database structure will be created.
- Directories will be verified to be writable.
2018-07-20 22:48:07 +00:00
- The board index will be written to ``TINYIB_INDEX``.
2010-12-31 23:24:55 +00:00
2020-10-14 16:48:20 +00:00
## Moderate
2014-06-24 19:51:22 +00:00
1. If you are not logged in already, log in to the management panel by clicking **[Manage]**.
2. On the board, tick the checkbox next to the offending post.
3. Scroll to the bottom of the page.
4. Click **Delete** with the password field blank.
- From this page you are able to delete the post and/or ban the author.
2020-10-14 16:48:20 +00:00
## Update
2010-12-31 23:24:55 +00:00
2014-06-28 08:57:30 +00:00
1. Obtain the latest release.
- If you installed via Git, run the following command in TinyIB's directory:
- `git pull`
- Otherwise, [download](https://code.rocketnine.space/tslocum/tinyib/archive/master.zip) and extract a zipped archive.
2014-06-28 08:57:30 +00:00
2. Note which files were modified.
- If **settings.default.php** was updated, migrate the changes to **settings.php**
2020-11-13 20:32:42 +00:00
- Take care to not change the value of `TINYIB_TRIPSEED`, as it is used to generate secure tripcodes, hash passwords and hash IP addresses.
2014-06-28 08:57:30 +00:00
- If other files were updated, and you have made changes yourself:
- Visit [code.rocketnine.space](https://code.rocketnine.space/tslocum/tinyib) and review the changes made in the update.
2013-04-16 03:15:47 +00:00
- Ensure the update does not interfere with your changes.
2018-07-20 18:59:29 +00:00
2020-10-14 16:48:20 +00:00
## Migrate
TinyIB includes a database migration tool.
2020-10-14 16:48:20 +00:00
While the migration is in progress, visitors will not be able to create or delete posts.
1. Edit **settings.php**
- Set ``TINYIB_DBMIGRATE`` to the desired ``TINYIB_DBMODE`` after the migration.
- Configure all settings related to the desired ``TINYIB_DBMODE``.
2. Open the management panel.
3. Click **Migrate Database**
4. Click **Start the migration**
5. If the migration was successful:
- Edit **settings.php**
- Set ``TINYIB_DBMODE`` to the mode previously specified as ``TINYIB_DBMIGRATE``.
- Set ``TINYIB_DBMIGRATE`` to a blank string (``''``).
- Click **Rebuild All** and ensure the board still looks the way it should.
2020-10-14 16:48:20 +00:00
## Support
2012-05-18 07:37:50 +00:00
1. Ensure you are running the latest version of TinyIB.
2. Review the [open issues](https://code.rocketnine.space/tslocum/tinyib/issues).
3. Open a [new issue](https://code.rocketnine.space/tslocum/tinyib/issues/new).
2012-05-18 07:37:50 +00:00
2020-10-14 16:48:20 +00:00
## Translate
Translation is handled [online](https://hosted.weblate.org/projects/tinyib/tinyib/).
2020-10-14 16:48:20 +00:00
## Contribute
2011-01-07 10:17:09 +00:00
**Note:** Please do not submit translations via pull requests. See above.
2020-09-06 14:23:06 +00:00
1. [Fork TinyIB.](https://code.rocketnine.space/repo/fork/6)
2. Commit code changes to your forked repository.
3. [Submit a pull request.](https://code.rocketnine.space/tslocum/tinyib/pulls)