Commit 12b94ea2 authored by Oliver Rümpelein's avatar Oliver Rümpelein

Initial commit, taken from old repo.

parents
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class
# C extensions
*.so
# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
*.egg-info/
.installed.cfg
*.egg
# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec
# Installer logs
pip-log.txt
pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
.hypothesis/
# Translations
*.mo
*.pot
# Django stuff:
*.log
local_settings.py
# Flask stuff:
instance/
.webassets-cache
# Scrapy stuff:
.scrapy
# Sphinx documentation
docs/_build/
# PyBuilder
target/
# Jupyter Notebook
.ipynb_checkpoints
# pyenv
.python-version
# celery beat schedule file
celerybeat-schedule
# SageMath parsed files
*.sage.py
# Environments
.env
.venv
env/
venv/
ENV/
# Spyder project settings
.spyderproject
.spyproject
# Rope project settings
.ropeproject
# mkdocs documentation
/site
# mypy
.mypy_cache/
[Core]
Name = CiteSystem
Module = cite
[Python]
Version = 3
[Documentation]
Description = "Interface to the F3LCites system"
This diff is collapsed.
Copyright (c) 2015-2017 Oliver Rümpelein, F3L Team
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
# F3LBot #
A XMPP-Bridge to the [f3lcites system][citesgh], or standalone cite storage.
## Basic Installation ##
The proposed way of running F3LBot is using a python virtualenv.
You need `errbot` as well as `sleekxmpp` installed and running,
and might need to set an extra plugin directory until this is set up
to be a real errbot plugin.
The following systemd `.service` works for me:
```systemd
[Unit]
Description=Runs f3lbot continuously
After=network.target
[Service]
Type=forking
User=<errbot user>
Group=<errbot group>
Environment=VIRTUAL_ENV="<path to virtualenv>"
Environment=PATH="$VIRTUAL_ENV/bin:$PATH"
ExecStart="${VIRTUAL_ENV}/bin/errbot -c <path to config> --daemon
RestartSec=5
Restart=always
[Install]
WantedBy=multi-user.target
```
## Cite-System ##
By default, the cite system will use a plain sqlite database, but you might
want to consider setting up an instance of [f3lcites][citesgh], which provides a simple web-frontend as well.
The configuration method of errbot provides templates for both setups.
[citesgh]: https://github.com/f3l/f3lcites
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment