summary refs log tree commit diff stats
path: root/getwtxt.yml
blob: 1e6c08f975c923f6cb1c697556ff1a8ee5519569 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
#############################################################
##  This config file can live in the following locations:  ##
##                                                         ##
##      ./                                                 ##
##      /usr/local/getwtxt/                                ##
##      /etc/                                              ##
##      /usr/local/etc/                                    ##
##                                                         ##
##  The first location found wins. The default filename    ##
##  is getwtxt.yml. This can be configured via command     ##
##  line flags:                                            ##
##                                                         ##
##  For "myconfig.json"                                    ##
##    ./getwtxt -config myconfig -type json                ##
##                                                         ##
#############################################################

#############################################################
##  Changing the following options requires a restart.     ##
#############################################################

# This is the port that getwtxt will bind to.
ListenPort: 9001

# The type of database you want to use. Currently,
# the following are supported:
#   leveldb
DatabaseType: "leveldb"

# The location of the database structure. Can be
# a relative or absolute path.
DatabasePath: "getwtxt.db"

# The path to the assets directory, which contains:
#     style.css
#     tmpl/index.html
AssetsDirectory: "assets"

#############################################################
##  The following options may be changed at any time.      ##
##  getwtxt will automatically reload the config when      ##
##  changes are detected.                                  ##
#############################################################

# If true, getwtxt will send all log messages, including
# requests, to stdout. It will ignore any set log file.
# Useful for debugging, but you probably want to keep
# logs.
StdoutLogging: false

# The file getwtxt will append log messages to. Can be a
# relative or absolute path.
LogFile: "getwtxt.log"

# This is the interval between data pushes from the 
# in-memory cache to the on-disk database. 
DatabasePushInterval: "5m"

# The time getwtxt will wait between attempts to scrape
# users' statuses from their twtxt.txt files
StatusFetchInterval: "1h"

# The following options pertain to your particular instance.
# They are used in the default page shown when you visit
# getwtxt in a web browser.
Instance:

  # The name of your instance.
  SiteName: "getwtxt"

  # Your instance's web address.
  URL: "https://twtxt.example.com"

  # Your name. 
  OwnerName: "Anonymous Microblogger"
  
  # Your email address.
  Email: "nobody@knows"

  # A short description of your instance, or your site.
  # This is shown at the top of the default web page
  # below your instance's name.
  Description: "A fast, resilient twtxt registry server written in Go!"
an class="s1">'DOCDIR = $(DOCDIR)' @echo 'DESTDIR = $(DESTDIR)' help: @echo 'make: Test and compile ranger.' @echo 'make install: Install $(NAME)' @echo 'make pypi_sdist: Release a new sdist to PyPI' @echo 'make clean: Remove the compiled files (*.pyc, *.pyo)' @echo 'make doc: Create the pydoc documentation' @echo 'make cleandoc: Remove the pydoc documentation' @echo 'make man: Compile the manpage with "pod2man"' @echo 'make manhtml: Compile the html manpage with "pod2html"' @echo 'make snapshot: Create a tar.gz of the current git revision' @echo 'make test: Test everything' @echo 'make test_pylint: Test using pylint' @echo 'make test_flake8: Test using flake8' @echo 'make test_doctest: Test using doctest' @echo 'make test_pytest: Test using pytest' @echo 'make todo: Look for TODO and XXX markers in the source code' install: $(PYTHON) setup.py install $(SETUPOPTS) \ '--prefix=$(PREFIX)' '--root=$(DESTDIR)' \ --optimize=$(PYOPTIMIZE) compile: clean PYTHONOPTIMIZE=$(PYOPTIMIZE) $(PYTHON) -m compileall -q ranger clean: find ranger -regex .\*\.py[co]\$$ -delete find ranger -depth -name __pycache__ -type d -exec rm -r -- {} \; doc: cleandoc mkdir -p $(DOCDIR) cd $(DOCDIR); \ $(PYTHON) -c 'import pydoc, sys; \ sys.path[0] = "$(CWD)"; \ pydoc.writedocs("$(CWD)")' find . -name \*.html -exec sed -i 's|'"$(CWD)"'|../..|g' -- {} \; TEST_PATHS_MAIN = \ $(shell find ./ranger -mindepth 1 -maxdepth 1 -type d \ ! -name '__pycache__' \ ! -path './ranger/config' \ ! -path './ranger/data' \ ) \ ./ranger/__init__.py \ $(shell find ./doc/tools ./examples -type f -name '*.py') \ ./ranger.py \ ./setup.py \ ./tests TEST_PATH_CONFIG = ./ranger/config test_pylint: @echo "Running pylint..." pylint $(TEST_PATHS_MAIN) pylint --rcfile=$(TEST_PATH_CONFIG)/.pylintrc $(TEST_PATH_CONFIG) test_flake8: @echo "Running flake8..." flake8 $(TEST_PATHS_MAIN) $(TEST_PATH_CONFIG) test_doctest: @echo "Running doctests..." @set -e; \ for FILE in $(shell grep -IHm 1 doctest -r ranger | grep $(FILTER) | cut -d: -f1); do \ echo "Testing $$FILE..."; \ RANGER_DOCTEST=1 PYTHONPATH=".:"$$PYTHONPATH ${PYTHON} $$FILE; \ done test_pytest: @echo "Running py.test tests..." py.test tests test_shellcheck: @echo "Running shellcheck..." sed '2,$$s/^\( *\)#/\1/' ./ranger/data/scope.sh | shellcheck -a - test_other: @echo "Checking completeness of man page..." @tests/manpage_completion_test.py test: test_pylint test_flake8 test_doctest test_pytest test_shellcheck test_other @echo "Finished testing: All tests passed!" man: pod2man --stderr --center='ranger manual' --date='$(NAME)-$(VERSION)' \ --release=$(shell date +%x) doc/ranger.pod doc/ranger.1 pod2man --stderr --center='rifle manual' --date='$(NAME_RIFLE)-$(VERSION_RIFLE)' \ --release=$(shell date +%x) doc/rifle.pod doc/rifle.1 manhtml: pod2html doc/ranger.pod --outfile=doc/ranger.1.html cleandoc: test -d $(DOCDIR) && rm -- $(DOCDIR)/*.html || true snapshot: git archive --prefix='$(NAME)-$(VERSION)/' --format=tar HEAD | gzip > $(SNAPSHOT_NAME) dist: snapshot todo: @grep --color -Ion '\(TODO\|XXX\).*' -r ranger .PHONY: clean cleandoc compile default dist doc help install man manhtml \ options snapshot test test_pylint test_flake8 test_doctest test_pytest \ test_other todo pypi_sdist