Skip to main content Link Search Menu Expand Document (external link)

Local Installation

Using a local installation of SCS for production deployments is not recommended. Please use the Docker image instead

To create a local installation of SCS, for example for debugging or testing extensions, you can clone the simple-configuration-server repository locally. Below is a basic example of using uWSGI to run the application. You will need:

  • A unix operating system (Windows should also work, but not with below steps)
  • Python 3.11 needs to be installed (Test using python3.11 --version)

Then:

  1. Create a .local subdirectory: mdkir -p .local
  2. Create an app.py file inside the .local directory, with the following contents:

    import scs
    
    app = scs.create_app()
    
  3. Open a terminal (bash) in the root directory of this repository, and do:

    ./install.sh
    source .env/bin/activate
    pip install uwsgi
    export PYTHONPATH=$(pwd)
    # Choose appropriate directories, make sure they exist
    export SCS_CONFIG_DIR=/etc/scs
    # Now start the app from uWSGI
    cd .local
    uwsgi -s /tmp/scs.sock --manage-script-name --mount /=app:app
    

uWSGI should now be running the SCS application. For further documentation, for example on how to configure NGINX, please look at the Flask documentation.