tinyib/README.md
Trevor Slocum 2aa8a8efa0 Migrate to code.rocket9labs.com
Run the following command to ensure continued updates:
  git remote set-url origin https://code.rocket9labs.com/tslocum/tinyib.git
2023-09-24 16:30:53 -07:00

8.4 KiB

TinyIB - Lightweight and efficient imageboard

Translate Donate via LiberaPay Donate via Patreon

A read-only demo is available.

Features

Got database? Get speed. Use MySQL, PostgreSQL or SQLite for an efficient set-up able to handle high amounts of traffic.

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.

  • GIF, JPG, PNG, SWF, MP4 and WebM upload.
  • YouTube, Vimeo and SoundCloud embedding.
  • CAPTCHA:
  • Reference links. >>###
  • Fetch new replies automatically. (See TINYIB_AUTOREFRESH)
  • Delete posts via password.
  • Report posts.
  • Block keywords.
  • 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)
    • Ban offensive/abusive posters across all boards.
    • Post using raw HTML.
    • Upgrade automatically when installed via git. (Tested on Linux only)
  • Translations:
    • Catalan, Chinese, Dutch, Finnish, French, German, Indonesian, Italian, Japanese, Korean, Norwegian, Polish, Portuguese, Romanian, Russian, Spanish (Mexico) and Turkish

Donate

Please consider supporting the continued development of TinyIB.

If you make a donation and there is a certain feature you'd like to see added to TinyIB, send me an email. I can't promise that I will implement the feature right away, however I will keep your support in mind.

Install

  1. Verify the following are installed:
    • PHP 5.5+
    • GD Image Processing Library
      • This library is usually installed by default.
      • If you plan on disabling image uploads to use TinyIB as a text board only, this library is not required.
    • cURL Library
      • This is recommended, but is not strictly required except when TINYIB_CAPTCHA is set to hcaptcha or recaptcha.
  2. CD to the directory you wish to install TinyIB.
  3. Run the command:
    • git clone https://code.rocket9labs.com/tslocum/tinyib.git ./
  4. Copy settings.default.php to settings.php
  5. Configure settings.php
    • 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. 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/.
      • Note: The mbstring PHP extension must be installed and enabled for TinyIB to properly support operating on and rendering text in any language other than English.
  6. CHMOD write permissions to these directories:
    • ./ (the directory containing TinyIB)
    • ./src/
    • ./thumb/
    • ./res/
    • ./inc/database/flatfile/ (only if you use the flatfile database mode)
  7. Navigate your browser to imgboard.php and the following will take place:
    • The database structure will be created.
    • Directories will be verified to be writable.
    • The board index will be written to TINYIB_INDEX.

Moderate

  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 one or more offending posts.
  3. Scroll to the bottom of the page.
  4. Click Delete.
    • You will be redirected to the management panel.
    • From this page you are able to delete the post(s) and/or ban the author(s).

Update

  1. Obtain the latest release.
    • If you installed via Git, run the following command in TinyIB's directory:
      • git pull
    • Otherwise, download and extract a zipped archive.
  2. Note which files were modified.
    • If settings.default.php was updated, migrate the changes to settings.php
      • Take care to not change the value of TINYIB_TRIPSEED, as it is used to generate secure tripcodes, hash passwords and hash IP addresses.
    • If other files were updated, and you have made changes yourself:
      • Visit code.rocket9labs.com and review the changes made in the update.
      • Ensure the update does not interfere with your changes.

Migrate

TinyIB includes a database migration tool.

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.

Support

  1. Ensure you are running the latest version of TinyIB.
  2. Review the open issues.
  3. Open a new issue.

Translate

Translation is handled online.

Contribute

Note: Please do not submit translations via pull requests. See above.

  1. Fork TinyIB.
  2. Commit code changes to your forked repository.
  3. Submit a pull request.