gochan/README.md

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`
3. After it finishes installing the Ubuntu VM, follow the printed instructions.

# Theme development
See [`sass/README.md`](sass/README.md) for information on working with Sass and stylesheets.
Fix broken SQLite connection, update README 2019-08-09 14:25:02 -07:00			`Gochan`
			`=======`
replace my half-baked tripcode generator with a better one, improve post sanitizing/cookie saving 2017-12-31 00:33:19 -08:00			`A semi-standalone imageboard server written in Go`
First commit 2013-02-02 14:53:39 -08:00
Update the README to add a little more clarity as to Gochan's method of operation. Also change the demo install URL to use TLS, and make it clear that it is the demo install. 2019-08-22 01:41:55 -07:00			`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`
Clean up README file 2015-08-28 05:55:41 -07:00

Fix broken SQLite connection, update README 2019-08-09 14:25:02 -07:00			`# Installation`
Clean up README file 2015-08-28 05:55:41 -07:00
Fix broken SQLite connection, update README 2019-08-09 14:25:02 -07:00			`## Basic installation (from a release)`
Have config.verbosity be determined by gochan.json, not by Makefile Finally add release instructions to README.md 2018-06-20 17:27:23 -07:00			`1. Extract the .tar.gz or the .zip file into a directory (for example, your home directory)`
Fix broken SQLite connection, update README 2019-08-09 14:25:02 -07:00			`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.`
Clean up README file 2015-08-28 05:55:41 -07:00
Fix broken SQLite connection, update README 2019-08-09 14:25:02 -07:00			`## 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)`
fix vagrant invalid file path error, update README 2017-08-12 16:46:00 -07:00			`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`
Rewrite CSS as Sass (.scss) files for better organization/loading 2018-11-25 14:16:22 -08:00			`3. After it finishes installing the Ubuntu VM, follow the printed instructions.`

Fix broken SQLite connection, update README 2019-08-09 14:25:02 -07:00			`# Theme development`
			See [`sass/README.md`](sass/README.md) for information on working with Sass and stylesheets.