Browse Source

SUDDENLY, DOCS

templates_refactor
dequis 6 years ago
parent
commit
ce59caf919
9 changed files with 805 additions and 216 deletions
  1. +5
    -0
      .gitignore
  2. +0
    -214
      INSTALL.md
  3. +2
    -2
      README.md
  4. +177
    -0
      docs/Makefile
  5. +74
    -0
      docs/cli.rst
  6. +258
    -0
      docs/conf.py
  7. +18
    -0
      docs/index.rst
  8. +109
    -0
      docs/install.rst
  9. +162
    -0
      docs/webserver.rst

+ 5
- 0
.gitignore View File

@@ -0,0 +1,5 @@
.*.swp
*.pyc
*.pyo
/templates/.cache
/docs/_build

+ 0
- 214
INSTALL.md View File

@@ -1,214 +0,0 @@
# Wakarimasen installation guide.

Wakarimasen is still experimental software - use it at your own risk and
if you know how to fix stuff when it breaks.

## Requirements

* Shell access to the server
* Python >= 2.6, <= 3
* Werkzeug
* SQLAlchemy >= 0.8
* Jinja2
* ImageMagick commandline tools (`convert` and `identify`)
* `file` command

### Supported deployment methods

* uWSGI
* FastCGI
* CGI (fallback)

### Supported webservers

* Apache: Completely supported
* nginx: Works, but a few features such as bans rely in .htaccess
* lighttpd: Works, but same as nginx.

Development server included (`python wakarimasen.py http`)

### Note on root access

Most instructions in here assume that you have at least a virtual private
server with root access. However, it's technically possible to install
requirements using [virtualenv][] and use wakarimasen over cgi or fastcgi if
already configured in a shared server.

## Installing dependencies

All dependencies should be available from the package manager of the average
linux distro.

If the python dependencies are too old, you could [install them with pip][pip]
instead. If you don't want or can't do system-wide installs of python packages,
[virtualenv][] exists and integrates nicely with pip.

If you don't have `convert`, `identify` or `file`, and can't install them with a
package manager system-wide, well, hope you don't mind not having images in the
imageboard.

## Basic installation (CGI)

- For CGI based setups the source code must be placed somewhere in the docroot

- Copy config.py.example to config.py. Edit it and set ADMIN_PASS, SECRET and
SQL_ENGINE. The format for SQL_ENGINE is the following:

SQL_ENGINE = 'mysql://USERNAME:PASSWORD@HOSTNAME/DATABASE'

You can also use sqlite:

SQL_ENGINE = 'sqlite:///wakarimasen.sqlite'
SQL_POOLING = False

Note that this will create the database in the current directory - please
avoid exposing it to the webserver!

- Now make sure the shebang line in wakarimasen.py points to the right
python interpreter and that the file has execute permissions. If you use suexec
for cgi, it must be chmod 755, too.

Visit `http://example.com/wakarimasen.py` - This should open the first time
setup page. Enter the ADMIN_PASS here.

- To create a new board called /temp/, copy the base_board directory:

cp -r base_board temp

Edit temp/board_config.py. Important settings are NUKE_PASS, TITLE and
SQL_TABLE. Keep in mind most of those options are not supported for now
(captcha, load balancing, proxy, etc).

- Go to `http://example.com/wakarimasen.py?board=temp` - This should rebuild the
cache and redirect you to your board.

## Webserver configuration

### Apache

#### CGI

TODO (Should be very similar to the first steps of FastCGI setup..)

#### FastCGI

Add this to your config:

DirectoryIndex wakaba.html

<Directory "/path/to/wakarimasen">
Options +ExecCGI
</Directory>

Choose either `mod_fastcgi`:

LoadModule fastcgi_module modules/mod_fastcgi.so
<IfModule fastcgi_module>
AddHandler fastcgi-script .fcgi
</IfModule>

Or `mod_fcgid`:

LoadModule fcgid_module modules/mod_fcgid.so
<IfModule fcgid_module>
AddHandler fcgid-script .py .fcgi
</IfModule>

### Nginx

#### CGI with fcgiwrap

See [this page](http://wiki.nginx.org/Fcgiwrap) for fcgiwrap installation details.

Then add this to the server block:

index wakaba.html;
include /etc/nginx/fcgiwrap.conf;

You should ensure that fcgiwrap.conf includes a location block, and that it
matches wakarimasen.py (sometimes it's limited to .cgi files). If it doesn't
have a location block, put that include inside one:

location /wakarimasen.py {
include /etc/nginx/fcgiwrap.conf;
}

If you don't do this, fcgiwrap might do weird stuff like throwing '502 bad
gateway' errors for most files.

#### FastCGI servers

Recent versions of wakarimasen have TCP and unix socket based standalone fastcgi
servers. To use them, start wakarimasen.py like this:

# start a tcp fcgi server with the default settings, in 127.0.0.1:9000
python wakarimasen.py fcgi_tcp

# bind tcp fcgi server to a certain ethernet interface, port 9001
python wakarimasen.py fcgi_tcp 192.168.0.1 9001

# start a unix socket fcgi server in /tmp/derp
python wakarimasen.py fcgi_unix /tmp/derp

In the nginx config:

index wakaba.html;
location /wakarimasen.py {
include /etc/nginx/fastcgi.conf;
fastcgi_pass unix:/tmp/derp;

# or: fastcgi_pass 127.0.0.1:9001;
}

When using unix sockets, check that the file is readable by the nginx user.

Nginx doesn't have a fastcgi process spawner. You'll have to write a init
script, a systemd unit, or use something like [supervisor][].

Or just leave the thing running in a tmux/screen session, only to find a few
weeks later that your wakarimasen has been offline for a long time because your
server mysteriously rebooted.

### Lighttpd

#### CGI

Just add this to the config:

server.modules += ("mod_cgi")
cgi.assign = (".py" => "/usr/bin/python2")
index-file.names += ("wakaba.html")

As an nginx fanboy I'm slightly annoyed at how easy this was.

#### FastCGI

TODO

### uWSGI

uWSGI is probably the best deployment setup. It can also be the most complex to
setup. This document is not going to cover the details, but you can check the
[uWSGI docs][ud]. In particular:

* The [quickstart][qs] gives a rough outline of the process.
* Note: wakarimasen can't run directly with the uwsgi http server for
now, you need to put it behind a real webserver.
* Note: The uwsgi "network installer" is awesome, try it out.
* Using the [emperor][emp] can raise the enterpriseness of your setup
significantly.
* The [web server integration][ws] page gives several alternatives for each
server.
* There are a few modules for apache. You have to grab them from the uwsgi
git repo and run the specified `apxs` command to compile and install.
* Nginx has built-in support of uwsgi. That page describes how to use it.

More detailed instructions soon&trade;

[ud]: http://uwsgi-docs.readthedocs.org/en/latest/
[qs]: http://uwsgi-docs.readthedocs.org/en/latest/WSGIquickstart.html
[emp]: http://uwsgi-docs.readthedocs.org/en/latest/Emperor.html
[ws]: http://uwsgi-docs.readthedocs.org/en/latest/WebServers.html
[supervisor]: http://supervisord.org/configuration.html#fcgi-program-x-section-settings
[pip]: http://www.pip-installer.org/en/latest/quickstart.html
[virtualenv]: http://www.virtualenv.org/en/latest/virtualenv.html

+ 2
- 2
README.md View File

@@ -29,9 +29,9 @@ Looks exactly like wakaba. You should already know what wakaba looks like.

### Installation

Installation instructions are available in the [INSTALL.md][] file
Installation instructions are available in the [docs][]

[INSTALL.md]: https://github.com/dequis/wakarimasen/blob/master/INSTALL.md
[INSTALL.md]: https://github.com/dequis/wakarimasen/blob/master/docs/install.rst

### Known issues



+ 177
- 0
docs/Makefile View File

@@ -0,0 +1,177 @@
# Makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build2
PAPER =
BUILDDIR = _build

# User-friendly check for sphinx-build2
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif

# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .

.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext

help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"

clean:
rm -rf $(BUILDDIR)/*

html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."

singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."

pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."

json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."

htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."

qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/wakarimasen.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/wakarimasen.qhc"

devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/wakarimasen"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/wakarimasen"
@echo "# devhelp"

epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."

latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."

latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."

latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."

text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."

man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."

texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."

info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."

gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."

changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."

linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."

doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."

xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."

pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

+ 74
- 0
docs/cli.rst View File

@@ -0,0 +1,74 @@
Commandline actions
====================

Wakarimasen includes a few administrative commands that can be used from
the commandline.

To use them, do:

::

python wakarimasen.py <command> [parameters]

To see usage info of an individual command, do:

::

python wakarimasen.py help <command>

Servers
-------

- fcgi_tcp *[host [port]]*

Starts a standalone FastCGI server over tcp. Defaults to listening on
127.0.0.1, port 9000

- fcgi_unix *<path>*

Starts a standalone FastCGI over unix socket. The path is required,
and you should ensure the permissions allow the webserver to connect.

- http *[host [port]]*

Starts a http server for development/testing purposes. Do not use in
production, even cgi is better than this.

Admin actions
-------------

- delete_by_ip *<ip> <boards>*

*<boards>* is a comma separated list of board names.

- rebuild_cache *<board>*

- rebuild_global_cache

Admin actions require some knowledge about the webserver environment.
For this reason, you need to pass the following environment variables

- ``DOCUMENT_ROOT``: full filesystem path to html files.
Example: ``/srv/http/imageboard.example.com/``

- ``SCRIPT_NAME``: url to wakarimasen.py without host part.
Example: ``/wakarimasen.py``

- ``SERVER_NAME``: hostname of the webserver.
Example: ``imageboard.example.com``

- ``SERVER_PORT``: port of the webserver *(optional)*.
Example: ``80``

If these values are wrong, it will probably result in a bunch of broken
links in the generated pages. Try rebuilding cache from the real web
interface.

Complete example usage:

::

DOCUMENT_ROOT=$PWD SCRIPT_NAME=/wakarimasen.py SERVER_NAME=0.0.0.0 \
python wakarimasen.py rebuild_global_cache

You could also have a script that sets this for you.

+ 258
- 0
docs/conf.py View File

@@ -0,0 +1,258 @@
# -*- coding: utf-8 -*-
#
# wakarimasen documentation build configuration file, created by
# sphinx-quickstart2 on Thu Apr 17 02:14:51 2014.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

import sys
import os

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))

# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = []

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix of source filenames.
source_suffix = '.rst'

# The encoding of source files.
#source_encoding = 'utf-8-sig'

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = u'wakarimasen'
copyright = u'2014, dequis'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '1.2'
# The full version, including alpha/beta/rc tags.
release = '1.2'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']

# The reST default role (used for this markup: `text`) to use for all
# documents.
#default_role = None

# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []

# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False


# -- Options for HTML output ----------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}

# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []

# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None

# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None

# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#html_extra_path = []

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True

# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}

# If false, no module index is generated.
#html_domain_indices = True

# If false, no index is generated.
#html_use_index = True

# If true, the index is split into individual pages for each letter.
#html_split_index = False

# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True

# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''

# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None

# Output file base name for HTML help builder.
htmlhelp_basename = 'wakarimasendoc'


# -- Options for LaTeX output ---------------------------------------------

latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',

# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',

# Additional stuff for the LaTeX preamble.
#'preamble': '',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
('index', 'wakarimasen.tex', u'wakarimasen Documentation',
u'dequis', 'manual'),
]

# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None

# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False

# If true, show page references after internal links.
#latex_show_pagerefs = False

# If true, show URL addresses after external links.
#latex_show_urls = False

# Documents to append as an appendix to all manuals.
#latex_appendices = []

# If false, no module index is generated.
#latex_domain_indices = True


# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'wakarimasen', u'wakarimasen Documentation',
[u'dequis'], 1)
]

# If true, show URL addresses after external links.
#man_show_urls = False


# -- Options for Texinfo output -------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'wakarimasen', u'wakarimasen Documentation',
u'dequis', 'wakarimasen', 'One line description of project.',
'Miscellaneous'),
]

# Documents to append as an appendix to all manuals.
#texinfo_appendices = []

# If false, no module index is generated.
#texinfo_domain_indices = True

# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'

# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False

+ 18
- 0
docs/index.rst View File

@@ -0,0 +1,18 @@
.. wakarimasen documentation master file, created by
sphinx-quickstart2 on Thu Apr 17 02:14:51 2014.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.

Wakarimasen docs
================

わかりまえん!

Contents:

.. toctree::
:maxdepth: 2

install
webserver
cli

+ 109
- 0
docs/install.rst View File

@@ -0,0 +1,109 @@
Installation
============

Wakarimasen is still experimental software - use it at your own risk and
if you know how to fix stuff when it breaks.

Requirements
------------

- Shell access to the server
- Python >= 2.6, <= 3
- Werkzeug
- SQLAlchemy >= 0.8
- Jinja2
- ImageMagick commandline tools (``convert`` and ``identify``)
- ``file`` command

Supported deployment methods
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- uWSGI
- FastCGI
- CGI (fallback)

Supported webservers
~~~~~~~~~~~~~~~~~~~~

- Apache: Completely supported
- nginx: Works, but a few features such as bans rely in .htaccess
- lighttpd: Works, but same as nginx.

Development server included (``python wakarimasen.py http``)

Note on root access
~~~~~~~~~~~~~~~~~~~

Most instructions in here assume that you have at least a virtual
private server with root access. However, it's technically possible to
install requirements using
`virtualenv <http://www.virtualenv.org/en/latest/virtualenv.html>`__ and
use wakarimasen over cgi or fastcgi if already configured in a shared
server.

Installing dependencies
-----------------------

All dependencies should be available from the package manager of the
average linux distro.

If the python dependencies are too old, you could `install them with
pip <http://www.pip-installer.org/en/latest/quickstart.html>`__ instead.
If you don't want or can't do system-wide installs of python packages,
`virtualenv <http://www.virtualenv.org/en/latest/virtualenv.html>`__
exists and integrates nicely with pip.

If you don't have ``convert``, ``identify`` or ``file``, and can't
install them with a package manager system-wide, well, hope you don't
mind not having images in the imageboard.

Basic installation (CGI)
------------------------

This section explains the simplest setup, assuming that your webserver
already has CGI working. If you need to configure your webserver for cgi
or something more efficient than cgi, see :doc:`webserver`

#. First, place the source code somewhere in the docroot. That is, the
``wakarimasen.py`` file should be where you'd put an index.html file.

#. Copy config.py.example to config.py. Edit it and set ``ADMIN_PASS``,
``SECRET`` and ``SQL_ENGINE``. The format for ``SQL_ENGINE`` is the
following:

::

SQL_ENGINE = 'mysql://USERNAME:PASSWORD@HOSTNAME/DATABASE'

You can also use sqlite:

::

SQL_ENGINE = 'sqlite:///wakarimasen.sqlite'
SQL_POOLING = False

Note that this will create the database in the current directory -
please avoid exposing it to the webserver!

#. Now make sure the shebang line in wakarimasen.py points to the right
python interpreter (the default is ``#!/usr/bin/python2``, do not use
a python 3.x interpreter) and that the file has execute permissions.
If you use suexec for cgi, it must be chmod 755, too.

Visit ``http://example.com/wakarimasen.py`` - This will check for any
configuration errors in your installation, and if everything is okay,
it should open the first time setup page. Enter the ``ADMIN_PASS``
here.

#. To create a new board called /temp/, copy the base\_board directory:

::

cp -r base_board temp

Edit temp/board\_config.py. Important settings are NUKE\_PASS, TITLE
and SQL\_TABLE. Keep in mind most of those options are not supported
for now (captcha, load balancing, proxy, etc).

#. Go to ``http://example.com/wakarimasen.py?board=temp`` - This should
rebuild the cache and redirect you to your board.

+ 162
- 0
docs/webserver.rst View File

@@ -0,0 +1,162 @@
Webserver configuration
-----------------------

Apache
~~~~~~

CGI
^^^

TODO (Should be very similar to the first steps of FastCGI setup..)

FastCGI
^^^^^^^

Add this to your config:

::

DirectoryIndex wakaba.html

<Directory "/path/to/wakarimasen">
Options +ExecCGI
</Directory>

Choose either ``mod_fastcgi``:

::

LoadModule fastcgi_module modules/mod_fastcgi.so
<IfModule fastcgi_module>
AddHandler fastcgi-script .fcgi
</IfModule>

Or ``mod_fcgid``:

::

LoadModule fcgid_module modules/mod_fcgid.so
<IfModule fcgid_module>
AddHandler fcgid-script .py .fcgi
</IfModule>

Nginx
~~~~~

CGI with fcgiwrap
^^^^^^^^^^^^^^^^^

See `this page <http://wiki.nginx.org/Fcgiwrap>`__ for fcgiwrap
installation details.

Then add this to the server block:

::

index wakaba.html;
include /etc/nginx/fcgiwrap.conf;

You should ensure that fcgiwrap.conf includes a location block, and that
it matches wakarimasen.py (sometimes it's limited to .cgi files). If it
doesn't have a location block, put that include inside one:

::

location /wakarimasen.py {
include /etc/nginx/fcgiwrap.conf;
}

If you don't do this, fcgiwrap might do weird stuff like throwing '502
bad gateway' errors for most files.

FastCGI servers
^^^^^^^^^^^^^^^

Recent versions of wakarimasen have TCP and unix socket based standalone
fastcgi servers. To use them, start wakarimasen.py like this:

::

# start a tcp fcgi server with the default settings, in 127.0.0.1:9000
python wakarimasen.py fcgi_tcp

# bind tcp fcgi server to a certain ethernet interface, port 9001
python wakarimasen.py fcgi_tcp 192.168.0.1 9001

# start a unix socket fcgi server in /tmp/derp
python wakarimasen.py fcgi_unix /tmp/derp

In the nginx config:

::

index wakaba.html;
location /wakarimasen.py {
include /etc/nginx/fastcgi.conf;
fastcgi_pass unix:/tmp/derp;

# or: fastcgi_pass 127.0.0.1:9001;
}

When using unix sockets, check that the file is readable by the nginx
user.

Nginx doesn't have a fastcgi process spawner. You'll have to write a
init script, a systemd unit, or use something like
`supervisor <http://supervisord.org/configuration.html#fcgi-program-x-section-settings>`__.

Or just leave the thing running in a tmux/screen session, only to find a
few weeks later that your wakarimasen has been offline for a long time
because your server mysteriously rebooted.

Lighttpd
~~~~~~~~

CGI
^^^

Just add this to the config:

::

server.modules += ("mod_cgi")
cgi.assign = (".py" => "/usr/bin/python2")
index-file.names += ("wakaba.html")

As an nginx fanboy I'm slightly annoyed at how easy this was.

FastCGI
^^^^^^^

TODO

uWSGI
~~~~~

uWSGI is probably the best deployment setup. It can also be the most
complex to setup. This document is not going to cover the details, but
you can check the `uWSGI
docs <http://uwsgi-docs.readthedocs.org/en/latest/>`__. In particular:

- The
`quickstart <http://uwsgi-docs.readthedocs.org/en/latest/WSGIquickstart.html>`__
gives a rough outline of the process.

- Note: wakarimasen can't run directly with the uwsgi http server
for now, you need to put it behind a real webserver.
- Note: The uwsgi "network installer" is awesome, try it out.

- Using the
`emperor <http://uwsgi-docs.readthedocs.org/en/latest/Emperor.html>`__
can raise the enterpriseness of your setup significantly.
- The `web server
integration <http://uwsgi-docs.readthedocs.org/en/latest/WebServers.html>`__
page gives several alternatives for each server.

- There are a few modules for apache. You have to grab them from the
uwsgi git repo and run the specified ``apxs`` command to compile
and install.
- Nginx has built-in support of uwsgi. That page describes how to
use it.

More detailed instructions soon™

Loading…
Cancel
Save