instructure / canvas-lms

The open LMS by Instructure, Inc.
https://github.com/instructure/canvas-lms/wiki
GNU Affero General Public License v3.0
5.72k stars 2.53k forks source link

Quick Start appears out of date and doesn't seem to work #1060

Open CreepyGnome opened 7 years ago

CreepyGnome commented 7 years ago

https://github.com/instructure/canvas-lms/wiki/Quick-Start

The quick start seems to contradict itself on preqs at the top it talks about 2.4 and later it says 2.1. Regardless I tried the CODE.sh script from Ben and the manual steps and can't get them to work. Tried Ubuntu desktop 14.04.2 and 14.04.5 desktop no luck. There are so many errors along the way to list.

Basically when is the last time some tried following the automatic and manual steps in the Quick Start.

Maybe I am missing something or doing something wrong, as I am new to Ruby but I am not new to Linux development.

My end goal is to get it setup to develop on Windows 10 with RubyMine and using Docker for Windows using its Ubuntu host. However, want to just get it working in straight Ubuntu 10.04.x with Docker first. So on a side note if anyone has advice for Canvas LMS development on Windows 10 using RubyMine I would love to chat with you.

shawniverson commented 7 years ago

Someone needs to kill off the Quick Start guide. The Production Start guide is really the way to go, even for development, in my opinion.

denslova commented 7 years ago

Same here, struggled with the quickstart having installed all the pre-reqs, the guide says Canvas now uses Yarn instead of npm, and then while running the automated script, npm error 128 can't download some git library Command failed: /usr/bin/git clone github.com/hapijs/qs.git while trying to create a temp folder on my Ubuntu 14.04.5 LTS (trusty). I tried removing node and npm, purging, reinstalling back to 6.11.0 - all to no avail. I have never spent 4 days on trying to install anything in this life. I get a feeling that the guide is written setting up everyone for failure, considering how many pages are out there describing how many errors pop up during the installation. Still struggling to install the production after giving up on the quickstart.

PS. Most curious, after finishing the installation of the production, what Apache serves in the browser is a root folder of var/canvas with a folder structure but I don't see any index.html or any endpoint that would launch the admin login page. Any help would be welcomed.

davisnw commented 6 years ago

Quick start still seems to be quite out of date. I've into multiple issues trying to setup with Ubuntu 18.04. First I tried the docker image, eventually got it almost working, but - it always showed the Canvas 404 page as it redirected to the login page).

I then tried walking through the non-docker setup - 'npm install' fails (I believe as a result of changes in https://github.com/instructure/canvas-lms/commit/97510022cda6b34a678f6e0905b6cc6262d65be7?diff=unified), and no mention is made of yarn on the quick start. The quick start says to use postgresql 9.3, production says to use at least 9.4.

omarkhan commented 6 years ago

For development I recommend the script/docker_dev_setup.sh script. It sometimes errors out on the first try but a second run will usually finish the job.

I would like to promote this script to be the "one true way" of setting up canvas for development, but most of the canvas engineers at Instructure prefer to develop outside of docker and I don't want to step on any toes. If you have any suggestions for improving the docs, feel free to open a pull request!

njwest commented 6 years ago

The Quickstart docs are dreadfully outdated, I managed to make some headway by switching to Node 8.10.0 but still with constant errors.

I highly recommend someone at instructure addressing these documentation issues, it's a major barrier to entry for teams looking to migrate LMSs...

ByrdOfAFeather commented 5 years ago

This would have been nice to see before starting. I finally got through the automated setup script without errors and am faced with image Time to try the production guide I guess

stale[bot] commented 3 years ago

Thanks for contributing to this issue. As it has been 2 years since the last activity, we are automatically closing the issue in 30 days. This is often because the request was already solved in some way and it just wasn't updated or it's no longer applicable. If that's not the case, please respond before the issue is closed, or post a message on the mailing list. We'll gladly take a look again!