||4 years ago|
|requirements||4 years ago|
|resthys||4 years ago|
|.gitignore||4 years ago|
|CHANGELOG.md||4 years ago|
|CONTRIBUTORS.txt||4 years ago|
|LICENSE||4 years ago|
|Makefile||4 years ago|
|README.md||4 years ago|
|config.env.example||4 years ago|
|manage.py||4 years ago|
|requirements.txt||4 years ago|
|setup.cfg||4 years ago|
Une interface REST partielle pour Noethys
On a Debian-based host - running at least Debian Stretch, you will need the following packages:
- python3-psycopg2 (optional, in case of a PostgreSQL database)
Note: if you're serving the application with uWSGI and NGINX on a sub location, ensure
that you've added
route-run = fixpathinfo: to your uWSGI configuration (from
Step by step
In waiting for a complete
Makefile, you will have to follow those steps to
install the application.
It assumes that you have downloaded the last release of resthys, extracted it and that you moved to that folder.
Start by creating a new virtual environment under
./venvand activate it:
$ virtualenv --system-site-packages ./venv $ source ./venv/bin/activate
Install the required Python packages depending on your environment:
$ pip install -r requirements/production.txt ... or ... $ pip install -r requirements/development.txt
Configure the application by setting the proper environment variables depending on your environment. You can use the
config.env.examplewhich give you the main variables with example values.
$ cp config.env.example config.env $ nano config.env
Note that this
./config.envfile will be loaded by default when the application starts. If you don't want that, just move this file away or set the
DJANGO_READ_CONFIG_FILEenvironment variable to
Create the database tables - it assumes that you have created the database and set the proper configuration to use it:
$ ./manage.py migrate
That's it! You should now be able to start the Django development server to check that everything is working fine with:
$ ./manage.py runserver
All the application files - e.g. Django code including settings, templates and
statics - are located into the
resthys/. It should
permit in a near future to distribute the application as a Python package and
install it system-wide.
Two environments are defined - either for requirements and settings:
development: for local application development and testing. It uses a SQLite3 database and enable debugging by default, add some useful settings and applications for development purpose - i.e. the
production: for production. It checks that configuration is set and correct, try to optimize performances and enforce some settings - i.e. HTTPS related ones.
You can override and extend statics and templates locally. This can be useful
if you have to change the logo for a specific instance for example. For that,
just put your files under the
Regarding the statics, do not forget to collect them after that. Note also that
local/ folder is ignored by git.
All the variable content - e.g. user-uploaded media, collected statics - are
stored inside the
var/ folder. It is also ignored by git as it's specific
to each application installation.
So, you will have to configure your Web server to serve the
var/static/ folders, which should point to
resthys is developed by Cliss XXI and licensed under the AGPLv3+.