Skip to content
/ sudochan Public template
forked from savetheinternet/Tinyboard

Sudochan is an open-source imageboard project written in PHP.

License

Notifications You must be signed in to change notification settings

anzweidrej/sudochan

 
 

Repository files navigation

Sudochan

Sudochan is a free, lightweight, fast, highly configurable, and user-friendly imageboard software package. It is written in PHP and has few dependencies.

Requirements

  • PHP >= 8.3
  • MySQL/MariaDB server
  • PHP extensions: mbstring, gd, pdo

Sudochan does not include an Apache .htaccess file nor does it need one.

Recommended

  • ImageMagick or GraphicsMagick (command-line)
  • OpenSSL
  • APCu, XCache, Redis, or Memcached
  • xgettext

Contributing

You can contribute to Sudochan by:

  • Submitting pull requests for patches, improvements, or translations
  • Providing feedback and suggestions
  • Writing or editing documentation

Installation

  1. Download and extract Sudochan to your web directory or get the latest development version with:
git clone git://github.com/anzweidrej/sudochan.git
cd sudochan
  1. Install Composer packages:
composer install
  1. Create a basic instance-config.php in the root directory.
  2. Navigate to /install.php in your web browser and follow the prompts.
  3. Sudochan should now be installed. Log in to /mod.php with the default username and password combination: admin / password.

NOTE: Please remember to change the administrator account password!

To run a development environment, use:

docker compose up -d --build

Support

Sudochan is still beta software, and there are bound to be bugs. If you find a bug, please report it.

If you need assistance with installing, configuring, or using Sudochan, you may find support from a variety of sources:

  • If you're unsure about how to enable or configure certain features, make sure you have read the comments in etc/config.php
  • Create a Github issue

License

This work is dual-licensed under MIT AND LicenseRef-Tinyboard (or any later version). You can choose between one of them if you use this work.

SPDX-License-Identifier: MIT AND LicenseRef-Tinyboard

Copyright (c) 2010-2014 Tinyboard Development Group (tinyboard.org)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

No portion of the Software shall be used to form a work licensed under any version of the GNU General Public License, as published by the Free Software Foundation.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

See LICENSE

About

Sudochan is an open-source imageboard project written in PHP.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PHP 62.3%
  • HTML 17.5%
  • JavaScript 10.5%
  • CSS 9.5%
  • Dockerfile 0.2%