Commit graph

36 commits

Author SHA1 Message Date
d2c96c5bc6
Enhance Docker documentation. (#882)
* Enhance Docker documentation.

Fixes #868

* Adress @zorun feedback.

* Update installation.rst
2021-10-22 17:56:41 +02:00
George Thomas
b94fc08138
Miscellaneous improvements to installation instructions (#819)
Co-authored-by: Glandos <bugs-github@antipoul.fr>
2021-07-28 22:32:55 +02:00
Baptiste Jonglez
9a5badd3be docs: Add SQLAlchemy workaround to install current release 2021-07-20 19:39:21 +02:00
Raju Subramanian
942617a436 Change Dockerfile to compile python dependencies at build time.
- Updated entrypoint.sh
- Updated docs for running with Docker
- Added .dockerignore
2021-07-14 18:01:34 +02:00
Glandos
31a9ed29f6 bump pymysql upper bound 2021-07-12 23:42:31 +02:00
Baptiste Jonglez
def6dba825 Replace MySQL by MariaDB in all documentation / README / changelog
Also document the new requirement for MariaDB >= 10.3.2

Fixes: #632
Fixes: #743
2021-07-05 08:52:13 +02:00
Glandos
74e222f1a1 remove usage of Flask-Script
Use flask.cli instead with compatibility layer for existing commands,
such as "runserver".
2021-06-06 15:13:21 +02:00
Glandos
0380521b4a Add python3.9 support 2020-11-24 22:52:46 +01:00
Jocelyn Delalande
55bce593f0 Use venv module rather than virtualenv
- simpler to use
- lighter dependency (or no dependency at all, depending on python distribution)
- retrocompatible

virtualenv package from pip to acheive virtual environment feature is no longer
needed, except for projects which need to support py2, which is no longer our
case.

Also, reword "virtualenv" to "virtual environment" in doc, to avoid confusion
with pip package name.

Ref #483
2020-07-26 20:14:59 +02:00
Jocelyn Delalande
48fabc346f Document how to switch python version for 5.x
Focus is on rebuilding venv (which are bound to a specific python minor
version).

Ref #483
Ref #571
2020-07-26 20:14:59 +02:00
Rémy HUBSCHER
10c35e41ce
Update install docs. 2020-04-24 15:22:37 +02:00
am97
eea50b9b2c
Misc small updates (#536) 2020-02-23 19:27:39 +01:00
9fe84bc1a2 Enhance postgresql installation docs. 2019-10-11 19:52:15 +02:00
093f2967c7 Clean and reorganise a bit the documentation 2019-09-06 22:35:41 +02:00
Luc Didry
84b096d3cd Systemd doc fixes + update CONTRIBUTORS 2019-05-21 10:46:41 +02:00
nailyk-fr
ba78ff7228 doc: install: Add gunicorn dependency
* Gunicorn is a mandatory dependency, add a notice.
2019-05-21 10:46:41 +02:00
nailyk-fr
bb5a1cfe84 doc: installation: Add systemd service
* Next to the addition of `conf/ihatemoney.service`,
   add installation notice.

Signed-off-by: nailyk-fr <nailyk_git@nailyk.fr>
2019-05-21 10:46:41 +02:00
bbf832bec7
Document PostgreSQL configuration. Fixes #403 (#415)
* Document PostgreSQL configuration. Fixes #403
2019-01-16 13:13:04 +01:00
ec6ebcf24e
Fix the nginx conf generation command 2018-12-12 14:39:51 +01:00
5fcf667914
Almet/docs/mail server configuration (#378)
* Replace the settings table with multiple sections.

It's easier to read, and easier to maintain. Fixes #251.

* Document external mail server configuration.

Fixes #278
2018-09-03 20:55:10 +02:00
07aabeb07f
Replace the settings table with multiple sections. (#376)
It's easier to read, and easier to maintain. Fixes #251.
2018-09-03 20:54:41 +02:00
JocelynDelalande
9caf213e1d Document MySQL setup (#357)
PyMySQL is more difficult to install since its version 0.9 since it now depends
on *cryptography* lib, which in turns depends on OpenSSL and Python dev files.

See https://github.com/PyMySQL/PyMySQL/issues/697
2018-07-17 00:22:23 +02:00
0livd
d9471733f8 Fix some anti patterns in docker deployment (#321)
- Use exec to run gunicorn and avoid creating a new process.
- Add the possibility to pass any additional parameters to
gunicorn.
- Use only one gunicorn worker by default as the usual way to
scale the app in production would be to use the scale command
of the cluster scheduler. Additional workers could still be
added by passing the "-w" gunicorn parameter to docker run.
2018-02-07 09:37:21 +01:00
Alexandre Avenel
2866c868d5 Fix some typos using codespell (#285) 2017-11-11 18:11:15 +01:00
Jocelyn Delalande
59fc6e0d78 Add an upgrade guide
fix #274
2017-11-01 21:51:47 +01:00
9d7376d46b
Add some information about Yunohost in the documentation. (#283) 2017-11-01 18:36:25 +01:00
Lucas Verney
0453599752 Update installation doc to include doc about production values, fix #266. (#282) 2017-11-01 01:56:05 +01:00
0livd
b4961f646a Add a DockerFile (#272)
Can be used to deploy the latest version from
PyPI in a production environment or from the
master branch in a dev environment.
2017-10-25 23:37:55 +02:00
JocelynDelalande
e3285bef36 Enhance install process by generating config files from templates (#275)
* Add a command to generate configuration examples

Config files are generated from templates (which remplace previous example files).

- solve the issue of hard-to-explain configuration examples
- ease pkg path seeking (avoid it, actually)
- add working defaults for sqlite and unix socket paths (instead of
  /replace/me/path/example)
- move settings comments from default_settings.py to ihatemoney.cfg.j2, as it is
  the one that will be facing user.

* Use generate-config command  in install doc

Also follow the new working defaults of templates for socket and db path.

* Fix doc settings table

On the long term, plaintext tables might destroy humanity.

* Mention templates dir URL in documentation

As requested by @almet
2017-10-23 18:05:50 +02:00
JocelynDelalande
40dda53607 Fix default SQLALCHEMY_DATABASE_URI value in doc (#267)
Reality-sync with default_settings.py

Not fixing the whole table layout because

- my text editor doesn't do it ;
- I'm too lazy ;
- #251 is IMHO the real way to this issue :)
2017-09-06 10:26:48 +02:00
0livd
7a918c9349 Enhance the dashboard. (#262)
* Update to a more flexible admin authentication
* Admin can now access any project
* Add delete and edit options in the dashboard
* Add a link to the dashboard in the nav bar

This is a rework of the changes proposed by @Olivd, so they can apply on top of
the latest master without trouble. All credit goes to him for the code.
2017-09-04 15:44:20 +02:00
JocelynDelalande
68e4114735 Streamline installation doc, now using pip (#252)
* Fix conf files to reflect module renaming

Python module was renamed budget → ihatemoney (see #243 and 6923367).
Now, "budget" relates to nothing.

* Harmonize `APPLICATION_ROOT` doc with other settings

* Fix link markup

* Switch documentation to recomend pip over git

- Update installation instruction
- Clearly separate dev setup from installation
- Some rewordings/section-ization by the way

* Add a hint on how to find the static path

This is a downside on the pip choice over git for installation.

We will have to ease that a bit. By doc or by code, before next release.

* Make the nginx deployment doc more accurate

* Add a big fat warning about SECRET_KEY in doc
2017-08-20 12:25:57 +02:00
0livd
75104d9c19 Add python 3.6 support (#259)
Closes #253
2017-08-20 12:21:59 +02:00
3a4282fd75 Absolute imports & some other improvements (#243)
* Use absolute imports and rename package to ihatemoney
* Add a ihatemoney command
* Factorize application creation logic
* Refactor the tests
* Update the wsgi.py module with the new create_app() function
* Fix some styling thanks to Flake8.
* Automate Flake8 check in the CI.
2017-07-07 00:06:56 +02:00
0livd
a836085448 Use a hashed password for ADMIN_PASSWORD (#236)
* Use a hashed password for ADMIN_PASSWORD

A generate_password_hash manage.py command is provided
Fixes #233

* Print a console warning for users using a clear text ADMIN_PASSWORD

* Reword ADMIN_PASSWORD doc

* Update changelog

* Update CHANGELOG.rst

- say it out loud
- bump to 2.0 (that's the logic of semantic versioning while introducing breaking changes)

* Bump to 2.0 (breaking change)

* Update hashed password warning message

* Mention the generate password hash in the Changelog
2017-06-27 00:16:32 +02:00
db29648956 Re-organize the documentation (#223)
* Re-organize the documentation

* Fix encoding errors for python 2

* Document the dependencies. Fixes #199

* Add a make update command. Fixes #211
2017-06-21 14:03:16 +02:00