Code Monkey home page Code Monkey logo

microtxt's Introduction

MicroTXT ๐Ÿ’ป

A tiny textboard style software written in PHP, no database required.

It is meant to be simple to use, host, and develop.

Features

  • โœ… Only PHP 5.x+ required (No database server, only sqlite3!)
  • โœ… Hidden/unlisted threads (start your thread title with .)
  • โœ… MOTDs
  • โœ… Less than 300kb uncompressed
  • โœ… Markdown for parent posts
  • โœ… No JavaScript required (JavaScript is used minimally but only to increase usability)

Installing

MicroTXT is only tested in a Linux environment, however, it should work on Windows/Unix with little to no modification.

Simply download and place the files in your PHP 5+ enabled website directory, and edit php/settings.php to your liking. You should probably also change rules.txt and faq.txt too.

You also need the GD PHP library installed on your PHP instance if you want to use the included captcha You also need Sqlite3 installed!

Configuring

Just edit php/settings.php

To disable the captcha just change $captcha to false, or to make the captcha appear every time, change $postsBeforeCaptcha to 0.

Warnings

This is new, there may be some issues with it.

Don't rely on it for huge communities, it doesn't scale for very high traffic projects (it's not meant to).

Change the salt in settings.php, otherwise tripcodes may be easier to brute force.

Prior to version 1.2, salts were not being applied to tripcodes, resulting in potentially easy to brute force tripcodes when bad passwords were used

Demo

You can use the demo board on my website.

Contributing

I will accept pull requests if they fix bugs or improve the software in a way I think fits the goals of the project.

Bug Reports

Well structured & polite bug reports are appreciated. Please try to include the following information in any bug reports:

  • PHP version
  • Web server version
  • Operating system version
  • MicroTXT Version (specified in settings.php)
  • What you have tried so far
  • Screenshots are helpful, but not necessarily required.

Development Roadmap & Planned features

  • Better post & reply formatting
  • Admin panel for setup, configuration, and moderation
  • Easy to use installation script (For Linux)
  • Perhaps a Docker container if there is demand

Contacting me

You can get in touch with me here

Donate ๐Ÿ’ฒ

If you want to support development, a dollar or two would be appreciated.

Bitcoin: 3GKzFQyfE35U6Gi9XeN3xGQ3tMZy3x2ByQ

Or, donate another way

microtxt's People

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.