dalareo/fiduswriter repository overview

⁠Fidus Writer

Fidus Writer is an online collaborative editor especially made for academics who need to use citations and/or formulas. The editor focuses on the content rather than the layout, so that with the same text, you can later on publish it in multiple ways: On a website, as a printed book, or as an ebook. In each case, you can choose from a number of layouts that are adequate for the medium of choice.

⁠Contributing

For details on contributing, please check http://fiduswriter.org/help-us/⁠

⁠License

All of Fidus Writer's original code is licensed under the GNU AFFERO GENERAL PUBLIC LICENSE, for details see LICENSE. Some third party libraries are licensed under other, compatible open source libraries. Licensing information is included in those files.

⁠Simple install

The following are instructions working on Ubuntu 16.04. Make adjustments as needed for other systems.

Please make sure, that you only use root permissions where advised. Otherwise, the installation will fail!

1. Install the development packages of libjpeg, gettext, zlib, python, npm and the python virtual environment creator by running:

1. Download the Fidus Writer sources to your computer from github by running:

1. Enter the fiduswriter folder:

1. Create a virtual environment. The following command will create an environment called "venv":

1. Activate the virtualenv by typing:

1. Install the requirements for running Fidus Writer by typing:

1. Initialize the Fidus Writer site by typing:

This will take a while.

1. Set up an admin user by typing:

1. Start the Fidus Writer server by typing:

1. In your browser, navigate to http://localhost:8000/⁠ and log in.

2. Notice that emails sent to the user appear in the console until an SMTP backend is configured (see below).

⁠Advanced options

⁠Setup SMTP for the email:

1. Copy the file configuration.py-default to configuration.py

2. Edit the lines that start with "EMAIL" uncommenting and adding your server configuration. Depending on your server setup you may also need to configure DEFAULT_FROM_EMAIL

⁠Use a MySQL server instead of sqlite:

1. Install the libmysql development package. On Debian/Ubuntu, you can do this by executing:

> `sudo apt-get install libmysqlclient-dev`

1. While inside your Fidus Writer virtualenv, install the python requirements specific to MySQL:

> `pip install -r mysql-requirements.txt`

1. Create a database and a user with access to it, making sure that the characterset of the database is set to UTF8. Check here http://www.debuntu.org/how-to-create-a-mysql-database-and-set-privileges-to-a-user/⁠ for how to create a database and set up user privileges. Make sure that when you create the database, you specify the characterset:

> `create database DBNAME character set utf8;`

1. Copy configuration.py-default to configuration.py, uncomment and fill out the section entitled "DATABASES".

⁠Use a PostgreSQL server instead of sqlite:

1. Install the PostgreSQL development package. On Debian/Ubuntu, you can do this by executing:

> `sudo apt-get install libpq-dev`

1. While inside your Fidus Writer virtualenv, install the python requirements specific to PostgreSQL:

> `pip install -r postgresql-requirements.txt`

1. Create a database and a user with access to it, making sure that the encoding of the database is set to UTF8. Check http://www.postgresql.org/docs/9.4/static/sql-createrole.html⁠ and http://www.postgresql.org/docs/9.4/static/sql-createdatabase.html⁠ for how to create a user and a database. Make sure that when you create the database, you specify the encoding:

> `CREATE DATABASE dbname OWNER dbuser ENCODING 'utf8';`

1. Copy configuration.py-default to configuration.py, uncomment and fill out the section entitled "DATABASES".

⁠Run the Fidus Writer server on an alternative port:

Instead of starting the server with:

Specify the port number like this:

9000 is the port number that this server listens on.

⁠Add new document styles:

1. While your server is running, navigate to http://[ADDRESS:PORT]/admin/style .
2. Add all required document fonts. Each font consists of a font file and a CSS definition of the font. Notice that instead the URL for the font file in the CSS definition should be [URL]
3. Add one or several new document styles. Insert the CSS definition and select all the fonts required by the style.
4. In your console, interrupt the server and run:

> `./manage.py create_document_styles`

1. Depending on your server setup, you may also have to run:

> `./manage.py collectstatic`

1. Restart your server.

⁠Development/upgrade:

1. Before upgrading, make a copy of your database and the media folder, then update all your documents to the latest document version. To do that, an administrator needs to navigate to /admin/maintenance/ on your server using a browser and click the update button.

2. Download the updated sources. If you have installed Fidus Writer from github and the upgrade is minor, the command will likely be:

> `git pull`

1. If there are changes to the JavaScript source code of Fidus Writer, you need to run:

1. If there are changes to translations, you need to run:

1. If there are changes to the database models, you need to run:

1. On a production server additionally:

1. Update all the documents again to the latest document version. An administrator needs to navigate to /document/maintenance/ on your server using a browser.

⁠More configurations options

Check the Wiki: https://github.com/fiduswriter/fiduswriter/wiki/Advanced-Configuration-on-Ubuntu⁠