Installing the App

Learn how to install the core Donation Store app on your webserver


This doc will explain how to install the application on your server. If you have not read the requirements and downloaded the files as mentioned in the requirements doc, please do so now as there is vital information on how to get your server ready for the install.

Information about the Setup Script

The setup will dowload and install the application for you on your server using Nginx and Gunicorn. If you use a different web server like Apache, you will have to manually configure it. Note, it WILL NOT install a database for you. Unless you plan on using SQLite, you must have MySQL or Postgres installed and running on a machine. You will be asked for database details by the script which you should fill in.

Running the Setup Script

The setup script HAS to be run as root or with root privileges.

Navigate to your home directory and run the script with Python, using:

cd /home
python3 setup.py

It will ask you for details throughout which you need to provide information about.

cd /home
sudo apt-get install build-essential
source /home/donationstore/env/bin/activate
pip3 install mysqlclient
python3 /home/donationstore/env/manage.py migrate

Running Donation Store

The above setup script creates a Donation Store daemon that runs it and it's dependencies. It has already started Donation Store, however you can use the following commands to control Donation Store if you need to.

service donationstore start
service donationstore stop
service donationstore restart

Side Notes

Please ensure that you never run Donation Store on a production server in DEBUG mode. This can be changed in the settings.py file found in DonationStoreV2/settings.py. By running the application in debug mode you are exposing information to the public about the inner workings of your application. DO NOT DO THIS.

By default, debug mode is turned off, however if you have certain things you need to view for testing, it can be turned on, but not on a production server viewed by customers.

Next Step

After the above steps you can now visit your application and follow the steps to start setting up your first webstore/creating your admin account. You can do so by visiting: yourdomain.com/install/.

After that has been complete, please read the Setting up Your First Webstore Doc as it has crucial information on how to setup your sub domain etc.

Have Questions? Open a Support Ticket

View Common Issues on the Knowledgebase

Video Guides on YouTube

Other clients and Donation Store developers hang out on our Discord server, where you can ask for support in #ds-chat, or if you are a Client and you don't uet have your Client role on Discord, let us know and we can add it. Once added you get access to our private Client's support channel.