* change feed defaults to be sane
* update docs * add git revision to version * bump to 2.5.1
This commit is contained in:
@@ -17,3 +17,4 @@ Hey, welcome to the documentation. This will help you use and develop with NNTPC
|
||||
|
||||
1. [Protocol](developer/protocol.md) - NNTPChan's protocol specification
|
||||
2. [JSON-RPC API](developer/api.md) - NNTPChan's JSON-RPC API
|
||||
3. [In Progress Sub Projects](developer/subprojects.md) - Ongoing subprojects that are not deployed on the mainline network yet
|
||||
|
@@ -1,41 +0,0 @@
|
||||
# How to install nntpchan on Debian stable
|
||||
|
||||
Install the initial dependencies:
|
||||
|
||||
```
|
||||
apt-get -y --no-install-recommends install imagemagick sox git ca-certificates \
|
||||
ffmpeg build-essential tcl8.5 postgresql postgresql-contrib
|
||||
```
|
||||
|
||||
## Configure postgresql
|
||||
|
||||
```
|
||||
su - postgres -c "createuser --pwprompt --encrypted srnd"
|
||||
su - postgres -c "createdb srnd"
|
||||
```
|
||||
Don't forget the password you make for the srnd user, you will need it for configuration.
|
||||
## Install golang
|
||||
|
||||
Download the golang tarball, extract it to `/usr/local`, and add it to the global profile:
|
||||
|
||||
```
|
||||
cd /opt
|
||||
wget https://storage.googleapis.com/golang/go1.9.linux-amd64.tar.gz
|
||||
tar -C /usr/local/ -xvzf go1.9.linux-amd64.tar.gz
|
||||
echo 'export PATH="$PATH:/usr/local/go/bin"' >> /etc/profile
|
||||
```
|
||||
|
||||
Your `PATH` is set at login, so log out and back in before proceeding.
|
||||
|
||||
## Install nntpchan
|
||||
|
||||
```
|
||||
cd /opt
|
||||
git clone https://github.com/majestrate/nntpchan.git
|
||||
cd nntpchan
|
||||
make
|
||||
```
|
||||
|
||||
Now you can proceed with [setting up NNTPChan](setting-up.md). When you get to the "set paths to external programs" step.
|
||||
|
||||
Run `./srndv2 setup` and follow the instructions [here](setting-up.md).
|
@@ -1,16 +0,0 @@
|
||||
Install the initial dependencies:
|
||||
|
||||
# apt-get -y --no-install-recommends install imagemagick sox git ca-certificates \
|
||||
ffmpeg build-essential tcl8.5 postgresql postgresql-contrib golang-go
|
||||
|
||||
Configure PostgreSQL:
|
||||
|
||||
# su - postgres -c "createuser --pwprompt --encrypted srnd"
|
||||
# su - postgres -c "createdb srnd"
|
||||
|
||||
Install nntpchan:
|
||||
|
||||
# cd /opt
|
||||
# git clone https://github.com/majestrate/nntpchan.git
|
||||
# cd nntpchan
|
||||
# make
|
@@ -47,3 +47,4 @@ Run `make`:
|
||||
|
||||
make
|
||||
|
||||
Next [set up the daemon](setting-up.md)
|
||||
|
60
doc/developer/subprojects.md
Normal file
60
doc/developer/subprojects.md
Normal file
@@ -0,0 +1,60 @@
|
||||
# subprojects
|
||||
|
||||
This is a list of subprojects related to the main nntpchan daemon
|
||||
|
||||
Mostly rewrite attempts
|
||||
|
||||
## nntpchand
|
||||
|
||||
Golang refactor of srndv2
|
||||
|
||||
Build Requirements:
|
||||
|
||||
* go 1.9
|
||||
|
||||
* GNU Make
|
||||
|
||||
To build:
|
||||
|
||||
$ make beta
|
||||
|
||||
To run tests:
|
||||
|
||||
$ make test-beta
|
||||
|
||||
To clean:
|
||||
|
||||
$ make clean-beta
|
||||
|
||||
## nntpd
|
||||
|
||||
Native C++ rewrite of nntpchan daemon
|
||||
|
||||
Build Requirements:
|
||||
|
||||
* GNU Make
|
||||
|
||||
* clang c++ compiler
|
||||
|
||||
* pkg-config
|
||||
|
||||
* libuv-1.x
|
||||
|
||||
* libsodium-1.x
|
||||
|
||||
To build:
|
||||
|
||||
$ make native
|
||||
|
||||
To run tests:
|
||||
|
||||
$ make native-test
|
||||
|
||||
To clean:
|
||||
|
||||
$ make clean-native
|
||||
|
||||
|
||||
## Tests
|
||||
|
||||
$ make test-full
|
Reference in New Issue
Block a user