Skip to content

Latest commit

 

History

History
376 lines (289 loc) · 17.9 KB

README.md

File metadata and controls

376 lines (289 loc) · 17.9 KB
Raw

Hosting on Your Machine Locally

Instructions for local setup (Mac and Windows):

Please ensure you have installed all of the software below:

  1. MySQL - use this page if you don't already have it

  2. Visual Studio Code (VS Code) - use this page if you don't already have it

    • Please feel free to use a different IDE if you do not like/prefer VS Code

  3. Install Python

    • For Windows, please install Python using Microsoft Store Application if you don't already have it...this will help prevent future errors with Flask
    • For macOS, please install Python using this page if you don't already have it

  4. Git - use this page if you don't already have it

  5. Clone this repository

    1. Open the Command Prompt (Windows) or Terminal (macOS)

      • When using the Command Prompt or Terminal, ensure that you enter after each command in order to complete and run the command

    2. Now we need to clone the repository onto your computer. Begin by using cd to whatever folder you want to have the project in

      • The cd <folder name> command allows you to access folders within your computer. Following the cd command should be the name of the folder you wish to enter. You must move through the folders as if you were opening them through Finder or your File Explorer.

        • If you would your folders are configured like this: QuasarResearch > Git > Code and you are starting in the QuasarResarch folder but would like to move to the Code folder, then you would need to do cd Git then cd Code

      • If you would like to see a list of the folders you can enter, use ls (Mac) or dir (Windows). The ls/dir command lists all the available folders in your current directory.

      • cd .. allows you to move back to the folder you were just previously in

        • If you were in QuasarResearch > Git > Code folder and you used cd .. then you would move to the Quasar > Git folder

    3. Use this command to clone the repository to your computer git clone https://<YOUR_GITHUB_USERNAME>@github.com/paolaUWB/QuasarResearchWebsite.git

      • Make sure to replace <YOUR_GITHUB_USERNAME> with your GitHub username and remove the angled brackets (< >)

  6. Check to see if all of the files were cloned

    1. Run the dir/ls command

    2. You should see a new "QuasarResearchWebsite" directory

  7. Open project in Visual Studio Code

    1. Open Visual Studio Code
    2. File -> Open folder and then navigate to the QuasarResearchWebsite folder that you just cloned

  8. Set up flask environment:

    1. Open a new terminal in Visual Studio Code and run python3 -m venv flaskEnv
      • To verify if this command worked, you should see a new folder called "flaskEnv" in the QuasarResearchWebsite folder
    2. Activate the environment
      • For Windows: you can do this by running the following command: flaskEnv\Scripts\activate in the terminal.
      • For Mac: you can do this by running the following command: source flaskEnv/bin/activate
    3. Install the necessary software using the commands below
      • pip install flask
      • pip install PyMySQL
      • pip install Flask-WTF
      • pip install python-dotenv
      • pip install flask-sqlalchemy
      • pip install flask-migrate
      • pip install flask-login
      • pip install email-validator

    • On Windows you may recieve an error message stating "running scripts is disabled on this system"

      1. To fix this open Windows PowerShell with administration privileges

        • To open, search "PowerShell" in the Windows Start menu and right click on "Powershell" then select "Run as administrator" from the context menu

      2. Enter 'set-executionpolicy remotesigned' to PowerShell

      3. When asked "Do you want to change the execution policy?", respond with 'Y' for yes

    • For more instructions on using python environments in Visual Studio Code, see https://code.visualstudio.com/docs/python/environments

  9. Add the secret environment variables:

    1. Create a new file in QuasarResearchWebsite/app/ and name it .env
    2. Add your secrets to the file with the following:
    SECRET_KEY=<WHATEVER YOU WANT>
MYSQL_DATABASE_PASSWORD=<YOUR MYSQL DB/ROOT PASSWORD>

  10. Add the path for downloads

    1. Create a new directory/folder in QuasarResearchWebsite/app/ and name it tmp
    2. Create a new file in QuasarResearchWebsite/app/tmp and name it quasars.csv

  11. Setup the MySQL database:

    1. In the VSCode Terminal, start mysql with & cmd.exe /c "mysql -u root -p --verbose --local-infile=1 < app/quasarDB_win.sql", and enter your password for root user
    2. python app/updateDatabase_win.py (this will update the paths to the images in the database)

  12. Now check to see if things are working. In the Visual Studio terminal type flask run

    1. If everything is working you should see something like: 
      (flaskEnv) PS C:\Users\guine\Desktop\test\QuasarResearchWebsite> flask run
* Environment: production
WARNING: This is a development server. Do not use it in a production deployment.
Use a production WSGI server instead.
* Debug mode: off
* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
    2. Follow the link on the last line to see if it runs. Your default internet browser should open to the home page of the website.
    3. Check that the images are loading correctly by going to the "Data Access" page under "Research", clicking on a row and seeing if the image shows up.
    4. Voila!

User Management

  1. The user database and login system follows these two tutorials

    1. https://blog.miguelgrinberg.com/post/the-flask-mega-tutorial-part-iv-database

    2. https://blog.miguelgrinberg.com/post/the-flask-mega-tutorial-part-v-user-logins

  2. To view all users

    1. flask shell

    2. See list of all usernames

      1. users = User.query.all()
      2. users

    3. See list of ids of users

      1. users = User.query.all()
      2. for u in users:
...     print(u.id, u.username)
...

  3. To add a user

    1. flask shell

    2. u = User(username='INSERT USERNAME HERE', email='INSERT EMAIL HERE')

    3. u.set_password('INSERT PASSWORD HERE')

    4. db.session.add(u)

    5. db.session.commit()

  4. To delete all users

    1. flask shell

    2. users = User.query.all()

    3. for u in users:
...     db.session.delete(u)
...

    4. db.session.commit()

 1. To delete a specific user
 
    1. `flask shell`
    
    1. Find the id of the user you want to delete. 
    
    1. `u = User.query.get(INSERT ID HERE)`
    
    1. `db.session.delete(u)`
    
    1. `db.session.commit()`

Hosting on UW Shared Host Servers

Necessary software:

  • Github account with access to this github page
  • Putty (if on windows)
  • Terminal (if on Mac or Linux)

Instructions for school server setup:

  1. Activate your UW shared web hosting

    1. Follow instructions on this page
      • Ensure that you subscribe to and activate Vergil Account, Homer/Ovid Account and Web Publishing

  2. SSH into the school servers:

    If you are using Windows:

    1. Connect to the UW network and open PuTTY
      • If you are unsure how to connect to the UW network, it is reccomended to use Husky OnNet. More information and how to download and use the software can be found here
      • If you do not have PuTTY, download it from here
    2. In PuTTY, under Host Name put vergil.u.washington.edu
      1. Port 22
      2. Connection type SSH
      3. Under Saved Sessions type whatever name you want
      4. Click Save (this will make it so that you can just double click or load next time you want to access the server)
      5. Click Open
        • If prompted with a PuTTY Security Alert message, click Accept
      6. Login as: Your UW ID
      7. Password: Your UW password
        • If you are new to SSH, know that you won't actually see your password get typed. It'll look invisible but it is still getting input into the system.
      8. Voila! You should be in now! Check that everything worked by typing ls into the command prompt. You should see one directory, "public_html"

    If you are using macOS:

    1. If you are on macOS, connect to the UW network and open Terminal
      • If you are unsure how to connect to the UW network, it is reccomended to use Husky OnNet. More information and how to download and use the software can be found here
    2. Type and enter ssh <YOUR_UW_NETID>@vergil.u.washington.edu
    3. When prompted for your password, use your UW password
      • If you are new to SSH, know that you won't actually see your password get typed. It'll look invisible but it is still getting input into the system.
    4. Voila! You should be in now! Check that everything worked by typing and entering ls into the command prompt. You should see one directory, "public_html"

    If you need more information, see this page

  3. Setup MySQL on the school servers:

    If you are using Windows:

    If you are using macOS:

    1. Set up Localhome
      1. Ensure you are still connected to UW's network and Vergil then type localhome in your Terminal
        • To recconnect to Vergil, follow the directions in the previous step again
      2. Exit from Vergil by typing and entering exit in your Terminal
      3. SSH into ovid by typing and entering <YOUR_UW_NETID>@ovid.u.washington.edu in your Terminal
    2. Make sure to write down your root password and username

    If you need more inforamtion, see this page

  4. Add files to the web server

    1. In the terminal clone files from github with the following commands:

      1. cd ~/public_html
      2. git clone https://<YOUR_GITHUB_USERNAME>@github.com/paolaUWB/QuasarResearchWebsite.git
      3. Enter your github password when prompted

    2. Check to see if all of the files were cloned

      1. ls
      2. You should see a new "QuasarResearchWebsite" directory in your public_html folder

  5. Set up a python virtual environment:

    1. cd ~/public_html
    2. type into the prompt:
      1. python3 -m venv flaskEnv (this will take a couple of seconds to run)
      2. source flaskEnv/bin/activate You should now see something like: (flaskEnv) vergil11$
      3. pip install flask
      4. pip install PyMySQL
      5. pip install Flask-WTF
      6. pip install python-dotenv
      7. pip install flask-sqlalchemy
      8. pip install flask-migrate
      9. pip install flask-login
      10. pip install email-validator

  6. Create a .env file to store secret information

    1. cd ~/public_html/QuasarResearchWebsite
    2. nano .env
    3. type the following: 
      SECRET_KEY= <WHATEVER_SECRET_KEY_YOU_WANT>
MYSQL_DATABASE_PASSWORD=<YOUR_MYSQL_DATABASE_ROOT_PASSWORD>
MYSQL_DATABASE_PORT = <YOUR_MYSQL_DATABASE_PORT>
    4. Save and close with the following commands: 
      ctrl+x
y
enter

  7. Add the path for downloads

    1. cd ~/public_html/QuasarResearchWebsite/app
    2. mkdir tmp
    3. cd ~/public_html/QuasarResearchWebsite/app/tmp
    4. touch quasars.csv

  8. Setup DB

    1. cd ~/public_html/QuasarResearchWebsite/app
    2. Create and update the database with the following command (it will run the commands in the .sql file) ~/mysql/bin/mysql < quasarDB.sql -u root -p --verbose
    3. Update DB with graph images
      1. cd ~/public_html/QuasarResearchWebsite/app
      2. Make sure your flask enviroment is activated
      3. python updateDatabase.py

  9. Edit htaccess and cgi files

    1. This next part is a little tricky and easy to make a mistake by leaving off slashes by accident. Be careful here!

    2. Make sure you are in your 'public_html' directory cd ~/public_html

    3. In the terminal create a new htaccess file by typing the following: pico .htaccess

      1. Enter the following into the file: 
        RewriteEngine on

RewriteRule ^/?$ /<YOUR_UW_NETID>/main.cgi [L]
      2. Save and close with the following commands: 
        ctrl+x
y
enter

    4. Now we need to create the CGI file

      1. cd ~/public_html

      2. Type pico main.cgi into the terminal

      3. Copy and paste this into the file (you can paste in Putty by clicking left and right mouse buttons at the same time)

        
#!flaskEnv/bin/python3

import sys, os
import cgi;
import cgitb; cgitb.enable()
from wsgiref.handlers import CGIHandler

sys.path.insert(0, 'QuasarResearchWebsite')
sys.path.insert(0, 'QuasarResearchWebsite/app')

from app.__init__ import app
CGIHandler().run(app)

      4. Save and close with:

        ctrl+x
y
enter

      5. Change the file permissions to allow the server to execute the program with chmod 755 main.cgi

      6. Now change the file permissions for the python init file with the following commands:

        1. cd ~/public_html/QuasarResearchWebsite/app
        2. chmod 755 __init__.py

    5. Check to see if it worked by going to your UW url. It will be https://students.washington.edu/<YOUR_UW_NETID>/

Troubleshooting (School Server):

  1. Basic MySQL Administration: https://itconnect.uw.edu/connect/web-publishing/shared-hosting/using-mysql-on-shared-uw-hosting/basic-mysql-administration/

  2. Troubleshooting Steps: https://itconnect.uw.edu/connect/web-publishing/shared-hosting/troubleshooting/

  3. If the Data Access page doesn't work (E.g. "Internal Server Error", data not displaying, etc.)

    1. Go to init.py
    2. Change the port number in the method connect_db() to have your port number

Troubleshooting (Windows):

  1. To update and access most recent files enter git pull into the terminal when you are in your QuasarResearchWebsite folder

  2. To push your most recent files to the master branch

    1. Enter git status to list out files that have been added/changed. the names of the files should be red
    2. Add files that are unecessary to the project to .gitignore
    3. Enter git status To list out files again to check if those files were removed.
    4. Enter git add . To the terminal.
    5. Enter git status to the terminal. The names of the files should now be green.
    6. Enter git commit -m "message". You can change the message to anything you want but it should be somewhat descriptive.
    7. Enter git `push to the terminal.
      1. If this is your first time doing so you should type in "git push --set-upstream origin YourBranch". Change "YourBranch" to the actual name of the branch.
    8. Go to the Github repository to merge your request

  3. If you recieve the error message: "running scripts is disabled on this system"

    1. Open Windows PowerShell with administration privileges
      1. To open, search "PowerShell" in the Windows Start menu and select "Run as administrator" from the context menu
    2. Enter set-executionpolicy remotesigned to PowerShell
    3. When asked "Do you want to change the execution policy?", respond with Y for yes
    4. For more information visit: https://www.faqforge.com/windows/windows-powershell-running-scripts-is-disabled-on-this-system/

  4. To add the mysql exe file to the path

    1. type "path" into the windows search bar and click "edit the system environment variables"
    2. click on environment variables
    3. click on path, then edit, then new
    4. then add the paths C:\Program Files\MySQL\MySQL Shell 8.0\bin\ and C:\Program Files\MySQL\MySQL Server 8.0\bin\ to the list
    5. click ok/apply
    6. restart your computer
1. If you recieve the error mesage: `module not found`
     1. Type `python -m pip list` into VS Code's terminal
     1. This will list all installed packages
     1. If the package you need is not in the list, enter `pip install [package name]` to the terminal
        1. For example, if you need to install PyMySql, enter `pip install PyMySQL` to the terminal

1. Setting the virtual enviroment in VS Code
     1. type "path" into the windows search bar and click "edit the system environment variables"
     1. Use `CTRL + SHIFT + P`
     1. click on "Python: select interpreter"
     1. Select the path that has flaskEnv/Scripts/ in the path name
     1. To learn more check this page: https://code.visualstudio.com/docs/python/environments