Giter Club home page Giter Club logo

gochan's Introduction

Gochan

A semi-standalone imageboard server written in Go

Gochan works in a manner similar to Kusaba X, Tinyboard and others. As such, Gochan generates static HTML files which can optionally be served by a separate web server.

Demo installation: https://gochan.org

Installation

Basic installation (from a release)

  1. Extract the .tar.gz or the .zip file into a directory (for example, your home directory)
  2. Copy gochan.example.json to either gochan.json or (if you're in a UNIX-like OS) /etc/gochan/gochan.json and modify it as needed. See the Configuration section for more info.
  3. If you're using nginx, copy gochan-http.nginx, or gochan-fastcgi.nginx if UseFastCGI is set to true to /etc/nginx/sites-enabled/, or the appropriate folder in Windows.
  4. If you're using a Linux distribution with systemd, you can optionally copy gochan.service to /lib/systemd/system/gochan.service and run systemctl enable gochan.service to have it run on startup. Then run systemctl start gochan.service to start it as a background service.
    1. If you aren't using a distro with systemd, you can start a screen session and run /path/to/gochan
  5. Go to http://[gochan url]/manage?action=staff, log in (default username/password is admin/password), and create a new admin user (and any other staff users as necessary). Then delete the admin user for security.

Configuration

  1. Make sure to set DBtype, DBhost, DBname, DBusername, and DBpassword, since these are required to connect to your SQL database. Valid DBtype values are "mysql", "postgres", and "sqlite3".
    1. To connect to a MySQL database, set DBhost to "tcp(ip:3306)" or a different port, if necessary.
    2. To connect to a PostgreSQL database, set DBhost to the IP address or hostname. Using a UNIX socket may work as well, but it is currently untested.
    3. To connect to a SQLite database, set DBhost to the path of the database file. It will be created if it does not already exist.
  2. Set DomainRegex,SiteDomain, since these are necessary in order to post and log in as a staff member.
  3. If you want to see debugging info/noncritical warnings, set verbosity to 1.

For developers (using Vagrant)

  1. Install Vagrant and Virtualbox. Vagrant lets you create a virtual machine and run a custom setup/installation script to make installation easier and faster.
  2. From the command line, cd into vagrant/ and run vagrant up. By default, MySQL/MariaDB is used, but if you want to test with a different SQL type, run GC_DBTYPE=dbtype vagrant up, replacing "dbtype" with either mysql, postgresql, or sqlite3.
  3. After it finishes installing the Ubuntu VM, follow the printed instructions.

For developers (using Docker)

Docker support is very unstable and doesn't fully work yet.

Theme development

See sass/README.md for information on working with Sass and stylesheets.

gochan's People

Contributors

eggbertx avatar onekopaka avatar pqyptixa avatar comraderat avatar chebyrash avatar

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.