dead-guru / devichan

A Dockerized lightweight and full featured PHP imageboard based on vichan

DeVichan

Dead Vichan - A Dockerized lightweight and full featured PHP imageboard based on vichan
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Upgrade
4. Roadmap
5. Contributing
6. License
7. Acknowledgments

About The Project

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

But is old, bad and dead

So, DeVichan - is a hard fork of vichan where we try to fix some stuff.

New features:

• All-in-one docker-compose.yml
• Updated twig (1 -> 3), jquery (2 -> 3) and lot others deps
• 404 and 500 error pages
• Banners for each board
• Statistics page (/stats/ or stats.php)
• Removed lot of dead code
• Tons of small fixes of js and templates
• CSS(main style.css and all configured themes) and JS minification
• photon and photon-dark are main supported themes

Of course, it is very difficult to fix code written in PHP5 times many years ago. But we can keep this legacy code safe and minimally up-to-date. Moreover, the conservative position of the original vichan developers worsens the situation even more. I wonder what we can get out of this venture

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your devichan locally. To get a local copy up and running follow these simple example steps.

Prerequisites

1. Install Docker
2. Install docker-compose

Installation

1. Clone the repo

   git clone [e-mail]:dead-guru/devichan.git

2. Run docker-compose

   docker-compose up -d

3. Install Composer packages

   docker-compose exec cphp composer install

4. Navigate to http://localhost/install.php in your web browser and follow the prompts.
5. devichan should now be installed. Log in to /mod/ with the default username and password combination: admin / password.
6. You can install some "themes" on /mod/?/themes

!!!Please remember to change the administrator account password.

See also: Configuration.

(back to top)

Upgrade

To upgrade from any version of Tinyboard or vichan or devichan:

Either run git pull to update your files, if you used git, or backup your inc/instance-config.php, replace all your files in place (don't remove boards etc.), then put inc/instance-config.php back and finally run install.php.

(back to top)

Roadmap

• Dockerize
• Update deps
• Archive Feature (https://github.com/dead-guru/devichan/tree/feature/arhcive1)
• Cloak IP and hash ip to db
• migrate to php 8.2

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GNU General Public Licens. See LICENSE.md for more information.

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to.

• vichan
• Tinyboard
• Twig

(back to top)