doc: Provide detailed installation outline that works for fresh Ubuntu #80
Conversation
Note that in order to get reliable installation instructions, it was necessary to modify the recording of requirements and add a script to install the requirements in a well-defined order, in addition to just adding documentation. Note the PostgreSQL instructions are still missing, as I will need to perform the installation on a clean Ubuntu system to determine the details of how to do it. Supersedes numberscope#49.
Fills in remaining details on Ubuntu installation to produce a complete set of steps to get backscope running. Resolves numberscope#73.
katestange
left a comment
katestange
left a comment
There was a problem hiding this comment.
It looks great, I just had a few tiny comments etc.
|
on it, will update per this feedback shortly. |
|
OK, I made every change suggested (in one form or another) so I am not responding to any of the individual review comments above. But the PR is ready for re-review. |
|
Great. So I think all this needs now to be merged is for someone to replicate the process. @liammulh please let us know if you will in the end be having time to do this. If not, we completely understand and will find another way to verify this so Kate can merge it. |
|
Sorry, @gwhitney, @katestange, I've had a busier week than I anticipated. I am taking my car to the mechanic tomorrow morning, and I'll have (I think) a few hours before work to review/test. |
liammulh
left a comment
liammulh
left a comment
There was a problem hiding this comment.
Other than the comments I left about the distutils package and the venv module, I had no trouble installing following the instructions in install-ubuntu.md on a fresh 4 GB Memory / 2 Intel vCPUs / 120 GB Disk / SFO3 - Ubuntu 22.04 (LTS) x64 Digital Ocean droplet. I did not configure Postgres, but I don't think that was giving us any trouble. I can check Postgres later this evening if you feel it's necessary, @gwhitney. Thanks!
Confused; how did you complete the installation to a server that would respond to API requests without configuring postgres? We would definitely want the installation to go through to that point. If you don't have time to do a test that goes through to that point, just let us know and we will handle some other way. Thanks for the above feedback, I will respond to it all ASAP. |
There was a problem hiding this comment.
Looks good. I followed all steps through running-backscope.md, including configuring Postgres. I was able to run backscope:
(.venv) # python manage.py runserver
Copyright 2020-2022 Regents of the University of Colorado.
This project is licensed under the
[MIT License](https://opensource.org/licenses/MIT). See LICENSE.md.
* Serving Flask app "flaskr" (lazy loading)
* Environment: production
WARNING: This is a development server. Do not use it in a production deployment.
Use a production WSGI server instead.
* Debug mode: on
* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
* Restarting with stat
Copyright 2020-2022 Regents of the University of Colorado.
This project is licensed under the
[MIT License](https://opensource.org/licenses/MIT). See LICENSE.md.
* Debugger is active!
* Debugger PIN: 285-071-117
Is there an easy way to test an API request?
Sure. Have two open shells on the same Ubuntu box (either by ssh'ing in twice or by using some sort of multiplexer on a single ssh connection) and in one shell, run the server as you did above, and while it is running, in the other shell execute a I will remove the offending newline shortly. ;-) |
|
Thanks, @gwhitney. I guess you could say I wasn't thinking outside the box. I started to use Anyway, I SSH'd to my droplet this morning and I |
Yup, I agree. And as I see no unresolved feedback in this PR, it'd be lovely if one of y'all approved and merged this :) |
3 participants
Also reorganizes the documentation to prune the README to
a reasonable size.
Note that in order to get reliable installation instructions,
it was necessary to modify the recording of requirements and
add a script to install the requirements in a well-defined order,
in addition to just adding documentation.
Supersedes #49.
Resolves #73.