cStock Project Documentation

cStock is a website that provides real-time, actionable HSA logistics data for managers and stakeholders to coordinate, plan, and identify solutions to better meet customer needs in a timely manner.

cStock is hosted at https://cstock.health.gov.mw/.

This documentation is intended for cStock administrators, system administrators, and developers.

Contents:

• cStock Administration
  • Admin site access
  • User Management
    • Administering a user
    • Making someone an administrator
    • Password Reset
• cStock System Administration
  • cStock System Overview
    • Hosting
    • Code
    • Key Services
  • Connecting to the Server
    • Prerequisites
    • VPN set up
    • Logging in to the VPN
    • Logging in to cstock
  • Common System Administration Tasks
    • Deploying Updated Code
    • Restarting application processes
    • Restarting other processes
    • Making configuration changes
    • Getting an application shell
    • Getting a database shell
  • Troubleshooting
    • Monitoring
    • Common errors
    • SMS issues
    • Report Issues
  • Server Installation
    • Create a system user
    • Install and configure MySQL
    • Restore cstock database
    • Install Python, pip, virtualenv, virtualenvwrapper, mysql dependencies
    • Install Redis
    • Create project directories
    • Set up cstock
    • Install and configure nginx
    • Install and configure supervisord
    • Set up and configure Kannel (SMS gateway)
• Setting up a development environment
  • Install prerequisites
  • Download the code
  • Setup the Python virtual environment
  • Create the database
  • Configure project settings
  • Initialize the Database
  • Create a superuser
  • Run the server
  • (Optional) Run celery and SMS router
  • Testing