Skip to content

install guide updates #3312

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 15, 2023
Merged

install guide updates #3312

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
de8d58c
install guide updates
AmandaBirmingham Aug 11, 2023
4b37f8c
One extra space added to trigger build
AmandaBirmingham Aug 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions INSTALL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

Qiita installation
Qiita installation
==================

Qiita is pip installable, but depends on specific versions of python and non-python packages that must be installed first. We strongly recommend using virtual environments; a popular solution to manage them is [miniconda](http://conda.pydata.org/miniconda.html), a lightweight version of the virtual environment, python distribution, and package manager anaconda. These instructions will be based on miniconda.
Expand Down Expand Up @@ -181,7 +181,7 @@ github organization. Each of the plugins have their own installation instruction
suggest looking at each individual .travis.yml file to see detailed installation
instructions. Note that the most common plugins are:
- [qtp-biom](https://github.com/qiita-spots/qtp-biom)
- [qtp-target-gene](https://github.com/qiita-spots/qtp-target-gene)
- [qtp-sequencing](https://github.com/qiita-spots/qtp-sequencing)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

qtp-target-gene has been renamed to qtp-sequencing. The old link still works, but it is surprising (and potentially worrying :) to the reader to end up at a different URL than the one they expected.

- [qp-target-gene](https://github.com/qiita-spots/qp-target-gene)

## Configure Qiita
Expand All @@ -206,9 +206,7 @@ Set your `QIITA_CONFIG_FP` environment variable to point to that file (into `.ba
source activate qiita
```

Update paths in the newly copied configuration file to match your settings, e.g. replace /home/travis/ with your user home directory.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are no travis paths in the config anymore.


If you are working on WSL, you will need to start the redis server with the following command before making a test environment:
If you are working on Mac OS X or WSL, you will need to start the redis server with the following command before making a test environment:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Installing on mac (not just WSL) fails if one doesn't run the redis-server start ... ask me how I know :)

```bash
redis-server --daemonize yes --port 7777
```
Expand All @@ -224,7 +222,7 @@ Finally, redbiom relies on the REDBIOM_HOST environment variable to set the URL
export REDBIOM_HOST=http://my_host.com:7379
```

## Confirgure NGINX and supervisor
## Configure NGINX and supervisor

(NGINX)[https://www.nginx.com/] is not a requirement for Qiita development but it's highly recommended for deploys as this will allow us
to have multiple workers. Note that we are already installing (NGINX)[https://www.nginx.com/] within the Qiita conda environment; also,
Expand Down