tinyib/README.md

87 lines
3.8 KiB
Markdown
Raw Normal View History

2013-07-31 04:35:25 +00:00
TinyIB - A Lightweight and Efficient [Image Board](http://en.wikipedia.org/wiki/Imageboard) Script
2010-12-31 23:24:55 +00:00
====
2010-06-22 07:52:15 +00:00
2013-04-15 01:05:08 +00:00
**Got database? Get speed.** Use [MySQL](http://mysql.com) or [SQLite](http://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.
2014-06-24 19:51:22 +00:00
To allow new threads without requiring an image, see the [Text Board Mode](https://github.com/tslocum/TinyIB/wiki/Text-Board-Mode) page.
For demos see the [TinyIB Installations](https://github.com/tslocum/TinyIB/wiki) page. [![githalytics.com alpha](https://cruel-carlota.pagodabox.com/5135372febbc40bacddbb13c1f0a8333 "githalytics.com")](http://githalytics.com/tslocum/TinyIB)
2012-05-18 07:37:50 +00:00
Features
------------
- GIF, JPG, PNG, SWF and WebA/WebM upload.
- Reference links >>###
2013-04-15 01:05:08 +00:00
- Delete post via password.
- Management panel:
- Administrators and moderators use separate passwords.
- Moderators are only able to delete posts.
- 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)
2013-04-15 01:05:08 +00:00
2010-12-31 23:24:55 +00:00
Installing
------------
2010-06-22 07:52:15 +00:00
2013-04-15 01:05:08 +00:00
1. Verify the following requirements are met:
- [PHP](http://php.net) 4 or higher is installed.
- [GD Image Processing Library](http://php.net/gd) is installed.
- This library is installed by default on most hosts.
2. CD to the directory you wish to install TinyIB.
3. Run the command:
2010-12-31 23:33:22 +00:00
- `git clone git://github.com/tslocum/TinyIB.git ./`
2013-04-15 01:05:08 +00:00
4. Copy **settings.default.php** to **settings.php**
5. Configure **settings.php**
- To remove the play icon from .SWF/.WebM thumbnails, delete or rename **video_overlay.png**.
2014-06-24 19:51:22 +00:00
- To allow WebA/WebM upload:
- Ensure your web host is running Linux.
2014-06-28 22:01:34 +00:00
- Install [mediainfo](http://mediaarea.net/en/MediaInfo) and [ffmpegthumbnailer](https://code.google.com/p/ffmpegthumbnailer/). On Ubuntu, run ``sudo apt-get install mediainfo ffmpegthumbnailer``.
2014-06-24 19:51:22 +00:00
- Set ``TINYIB_WEBM`` to ``true``.
2013-04-16 01:20:08 +00:00
6. [CHMOD](http://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/flatfile/ (only if you use flat file for the database)
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.
- The file index.html will be created containing the new image board.
2010-12-31 23:24:55 +00:00
2014-06-24 19:51:22 +00:00
Moderating
------------
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.
2010-12-31 23:24:55 +00:00
Updating
------------
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://github.com/tslocum/TinyIB/archive/master.zip) and extract a zipped archive.
2. Note which files were modified.
- If **settings.default.php** was updated, migrate the changes to **settings.php**
2013-04-15 01:05:08 +00:00
- Take care to not change the value of **TINYIB_TRIPSEED**, as it would result in different secure tripcodes.
2014-06-28 08:57:30 +00:00
- If other files were updated, and you have made changes yourself:
2013-04-16 03:15:47 +00:00
- Visit [GitHub](https://github.com/tslocum/TinyIB) and review the changes made in the update.
- Ensure the update does not interfere with your changes.
2011-01-07 10:17:09 +00:00
2012-05-18 07:37:50 +00:00
Support
------------
Contact tslocum@gmail.com
2011-01-07 10:17:09 +00:00
Contributing
------------
2013-04-15 01:05:08 +00:00
1. Read the [GitHub Forking Guide](http://help.github.com/forking/).
2. Fork TinyIB.
3. Commit code changes to your forked repository.
4. Submit a pull request describing your modifications.