Archived
1
0

more documentation

This commit is contained in:
jeff 2015-08-04 11:10:30 -04:00
parent d677f96e08
commit 626066c188
3 changed files with 96 additions and 14 deletions

View File

@ -1,23 +1,27 @@
# nntpchan #
# NNTPChan #
## requirements ##
NNTPChan (previously known as overchan) is a decentralized imageboard that uses nntp to synchronize content between many different servers. It utilizes cryptograpghicly signed posts to perform optional/opt-in decentralized moderation (currently work-in-progress)
* linux or freebsd
* go 1.4 or higher
* libsodium 1.0 or higher
* imagemagick
* postgresql
## getting started ##
## setting up ##
If you don't want to compile from source, you can download a precompiled binary [here](https://github.com/majestrate/srndv2/releases) when they are released.
### debian jessie/wheezy ###
After you [built and installed the daemon](build-daemon.md) and [set up your database](database-setup.md), clone this repository and start up the daemon
Debian doesn't has go 1.3, we need 1.4 or higher to build the nntpchan daemon.
# clone it
git clone https://github.com/majestrate/nntpchan
cd nntpchan
If you don't want to compile from source download a precompiled binary [here](#)
# set up the workspace
srndv2 setup
## building the daemon ##
# run the daemon
srndv2 run
after you have satisfied the dependancies, run:
Then open http://127.0.0.1:18000/ukko.html in your browser.
go install github.com/majestrate/srndv2
*PLEASE* report any bugs you find while setting up or building [(here)](https://github.com/majestrate/nntpchan/issues) so that the problems get fixed (^:
For questions or support find me on [IRC](https://qchat.rizon.net/?channels=#8chan-dev):
__uguu__ on irc.rizon.net usually in #8chan-dev

55
build-daemon.md Normal file
View File

@ -0,0 +1,55 @@
# building the daemon #
## requirements ##
* linux or freebsd
* go 1.4 or higher
* libsodium 1.0 or higher
* imagemagick
## debian ##
Debian Jessie has go 1.3, we need 1.4 or higher to build the nntpchan daemon so let's do that first, assumes 64bit linux:
#
# --->> DO NOT RUN AS ROOT <<---
# (you probably will break stuff really bad if you do)
#
# make directory for go's packages
mkdir -p $HOME/go
# set up a directory for our go distribution
mkdir -p $HOME/local
cd $$HOME/local
# obtain and unpack go binary distribution
wget https://storage.googleapis.com/golang/go1.4.2.linux-amd64.tar.gz -O go-stable.tar.gz
tar -xzvf go-stable.tar.gz
# set up environmental variables for go
export GOROOT=$HOME/local/go
export GOPATH=$HOME/go
export PATH=$GOROOT/bin:$GOPATH/bin:$PATH
# put environmental variables in bash_alises for later
echo 'export GOROOT=$HOME/local/go' >> $HOME/.bash_aliases
echo 'export GOPATH=$HOME/go' >> $HOME/.bash_aliases
echo 'export PATH=$GOROOT/bin:$GOPATH/bin:$PATH' >> $HOME/.bash_aliases
We'll also need to install some dependancies that come with debian:
# as root
apt-get update
apt-get install libmagickwand-dev libsodium-dev
Now you can build the daemon:
go install github.com/majestrate/srndv2
It will create an executable at $GOPATH/bin/srndv2 which is already in our $PATH so it can be run by typing ``srndv2``

23
database-setup.md Normal file
View File

@ -0,0 +1,23 @@
Postgres on Debian:
# install
apt-get install postgresql postgresql-client
Setting up postgres (as root)
# become postgres user
su postgres
# spawn postgres admin shell
psql
You'll get a prompt, enter the following:
CREATE ROLE srnduser WITH LOGIN PASSWORD 'srndpassword';
CREATE DATABASE srnd WITH ENCODING 'UTF8' OWNER srnduser;
\q
Change the username and password as desired.