manual

Configure the application

A python module is a file suffixed with .py. Python modules are translated to binary instructions; the instructions are executed by the computer. A python module may import other python modules. A python virtual environment stores python modules imported by the python module to be executed. tinyshop executes app.py. An example of an imported set of modules is flask.

Required inputs

• GitHub account
• server

Instruction set

• Obtain images of each offer; store them in the private tinyshop repository: tinyshop/client/assets.
  • Understand that image size is correlated with load time; images greater than 1000x1000 pixels will not load instantly.
• Obtain the offering.csv template.
  • Open a shell.
  • Change to the server directory in the private tinyshop repository: tinyshop/server.
  • Execute wget https://tinyshops.org/assets/offering.csv to get the offering.csv template.
• Populate offering.csv.
  • Execute wget https://tinyshops.org/assets/example-offering.csv to get a populated example of offering.csv.
• Configure tinyshop.
  • Execute wget https://tinyshops.org/assets/config.json to get the config.json template.
  • Open config.json in a text editor.
    • Set "DOMAIN" to "https://domain.org" replacing domain.org with the root domain.
    • Get the secret key here; set "STRIPE_SECRET_KEY" to "key" replacing key with the secret key.
    • Get the signing secret for the webhook endpoint here; set "STRIPE_WEBHOOK_SECRET_KEY" to "secret" replacing secret with the signing secret.
    • Set "SHIPPING" to either true or false. If true, Stripe will collect the payer shipping address.
    • If "SHIPPING" is false, set "SHIPPING_COUNTRIES" to "". If "SHIPPING" is true, set "SHIPPING_COUNTRIES" to ["country"] replacing country with the two-letter ISO country code of the country to which you ship. Valid countries are here. If you ship to multiple countries, do so like the following ["country", "country2"].
    • If "SHIPPING" is false, set "SHIPPING_AMOUNT" to "". If "SHIPPING" is true, set "SHIPPING_AMOUNT" to x replacing x with the shipping amount for each order in US cents. For example, if the order shipping amount is $7.50, set "SHIPPING_AMOUNT" to 750.
    • Save and exit the text editor.
• Execute git add . to add the files to the staging area.
• Execute git commit -m "Configure private tinyshop repository." to commit the files to the repository.
• Execute git push origin master to push the commit to the GitHub private tinyshop repository.
• Clone the GitHub private tinyshop repository on the server.
  • Open a secure shell on the server.
  • Execute git clone https://github.com/user/tinyshop.git, replacing user with the GitHub username.
• Define git email and name.
  • Execute git config --global user.email "email" replacing email with the GitHub no-reply email address or the domain email address.
  • Execute git config --global user.name "name" replacing name with the GitHub username.
• Create the virtual environment.
  • Execute python3 --version to confirm python3 is installed.
  • Create the virtual environment.
    • Execute mkdir venv to create the virtual environment directory; change to the directory.
    • Execute sudo apt install python3.x-venv replacing x with the version of python3 installed on the server.
    • Execute python3 -m venv tinyshop to name the virtual environment tinyshop.
• Activate the virtual environment.
  • Execute source tinyshop/bin/activate to activate the virtual environment.
• Install the required python modules in the virtual environment.
  • Change to the /tinyshop/server directory.
  • Execute python3 -m pip install -r requirements.txt to install the required python modules.
• Test tinyshop.
  • Execute python test.py to execute the test.py Python module; test.py stores unit tests of tinyshop. The shell should log Tests passed in x seconds.
• Administrate tinyshop.
  • Execute python administrate.py. In this instance, administrate.py validates config.json, creates the database, and sets the database offers to those stored in offering.csv.
• Configure nginx using TLS.
  • Execute sudo snap install --classic certbot to install certbot using snap. See rationale for using the snap package manager here.
  • Execute sudo certbot certonly --nginx --domain domain.org replacing domain.org with the root domain to generate the TLS certificate and key.
    • Enter the domain email address.
  • Change to the /etc/nginx/conf.d directory.
  • Execute sudo rm default.conf to remove the default server configuration file.
  • Execute sudo touch domain.conf replacing domain with the domain to create the domain server configuration file.
  • As a super user, edit the domain server configuration file in the nano text editor to the below replacing all five instances of domain.org with the root domain.

  • 
        server {
            listen 80;
            server_name domain.org;
            return 301 https://domain.org$request_uri;
        }
        server {
            listen 443 ssl;
            server_name  domain.org;
            ssl_certificate /etc/letsencrypt/live/domain.org/fullchain.pem;
            ssl_certificate_key /etc/letsencrypt/live/domain.org/privkey.pem;
            root /home/user/tinyshop/client;
            location / {
                index index.html;
            }
            location /server/ {
                proxy_pass http://127.0.0.1:5000;
                proxy_set_header Host $host;
                proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
            }
        }
    
    

  • Execute sudo systemctl reload nginx to reload nginx, thus applying the configuration changes.
• Run app.py.
  • Execute tmux to create a tmux session.
  • Activate the virtual environment.
  • Change to the /tinyshop/server directory.
  • Execute python app.py to run tinyshop.
  • Enter ctrl+b, then enter d to exit the tmux session.