origami.envstores all the environment variables necessary to run Origami.
HOSTshould be set to the hostname of the serverPORTshould be set to the port you want the server to listen on. (Generally 80)DB_NAMEwill be used to set the name for your postgres databaseDB_PASSwill be used to set the password for the database user. This is also the admin passwordDB_USERis the username for a user who can modify the database. This is also the admin usernameDB_USER_EMAILstores the email for the adminDB_HOSTshould be set to postgres in production and localhost in developmentREDIS_HOSTshould be set to redis and localhost in development
Origami/outCalls/config.jsstores config variables needed by the UI.
CLIENT_IPshould be set to the same value asHOSTinorigami.envCLIENT_PORTshould be set to the same value asPORTinorigami.env- For
DROPBOX_API_KEY, check step 3 of configuring Origami
Use docker to setup Origami on production
You can run the server with the help of docker and docker-compose.
Run docker-compose up
This application requires node v5+ and Python 2.7/3.4+
pip install virtualenvvirtualenv venvvenv = Name of virtualenvsource venv/bin/activate
Note: Step 2 will create a folder named venv in your working directory
-
Clone this repository
-
Navigate to the repo. Usually
cd Origami/ -
Add all the python dependencies.
pip install -r requirements.txt -
Add all the javascript dependencies
yarn(preferably) ornpm install -
Setup redis
docker run -d -p 6379:6379 --name origami-redis redis:alpine -
Setup the environment
source origami.env
python manage.py makemigrations
python manage.py migrate
python manage.py initadmin
- Start the server by
python manage.py runserver --noworker - Start the worker by
python manage.py runworker node server.js- Go to localhost:8000 Visit Read the docs for further instructions on Getting started
This software is licensed under GNU AGPLv3. Please see the included License file. All external libraries, if modified, will be mentioned below explicitly.