Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Documentation update
  • Loading branch information
Klaus Thoden committed Jan 22, 2020
1 parent 01fe334 commit fe95842
Showing 1 changed file with 21 additions and 4 deletions.
25 changes: 21 additions & 4 deletions README.md
Expand Up @@ -11,17 +11,34 @@ original files on the server.
Copy the `generated_files` folder to the server and from there run the
script.

## Dependencies
- texlive-xetex
- python3-pypdf2

## Config file
The program requires a config file called `cred.cfg` that stores some
paths and the data for accessing the database. It should contain the
following fields:
The program requires a config file that stores some paths and, if a
postgres database is used, the credentials for it. If several
publication platforms are used, simply create different config files
for each instance.

It should contain at least the following fields:

```
[server]
media_dir:
production_url:
```
When using SQLite, you can specify the database file like this:

```
[sqlite]
database_file:
```

[database]
Insert the postgres database credentials like this:

```
[postgres]
database_name:
user:
host:
Expand Down

0 comments on commit fe95842

Please sign in to comment.