Opened 8 years ago

Closed 7 years ago

#7844 closed enhancement (fixed)

No instructions for how to run a local Atlas web server

Reported by: evjan Owned by: hellais
Priority: Very Low Milestone:
Component: Metrics/Relay Search Version:
Severity: Keywords:
Cc: Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description

Not that it is terribly complicated, but there are no instructions on how to get started with running an Atlas web server locally on your machine after getting the source.

A simple addition to the Readme would help.

Child Tickets

Change History (11)

comment:1 Changed 8 years ago by evjan

Status: newneeds_review

I've added some instructions here: https://github.com/evjan/Atlas/tree/readme-added-running-instructions

Please review.

comment:2 Changed 8 years ago by hellais

I merged this to master. Though it's actually ideal to install tornado not from root, but with a virtualenv. You can see how this is done, by looking at the ooniprobe install guide: https://github.com/hellais/ooni-probe#configurating-a-virtual-environment

You don't need to actually need to use virtualenvwrapper. Something like this should be sufficient:

It is not recommended to install python packages as root, but to use a
virtualenvironment. You may do so on debian with:

::

apt-get install python-pip

or on Mac OSX with homebrew

::

brew install python

::

pip install virtualenv
virtualenv ENV
source ENV/bin/activate
pip install tornado

Every time you wish to run the tool you must first run:

::

source ENV/bin/activate

comment:3 Changed 7 years ago by phw

I think it's sufficient to simply mention that Tornado needs to be installed. Installation instructions will be outdated and confusing at some point. I updated the Readme.rst in the branch updated_readme at https://gitweb.torproject.org/user/phw/atlas.git Apart from removing detailed installation instructions, I renamed "TorStatus" to "Atlas" and fixed some other minor parts.

comment:4 Changed 7 years ago by karsten

I wonder, should we even mention Tornado in the installation instructions? For development purposes it's sufficient to use a URL like file:///Users/karsten/src/atlas/index.html, and the deployed Atlas uses Apache, not Tornado. I'd say it's fine to remove Tornado and suggest the file:/// URL or a web server of choice with the Atlas directory as document root.

phw, if you're trying to remove "TorStatus" instances from the code, also run: git grep "Tor Status"

Thanks!

comment:5 in reply to:  4 ; Changed 7 years ago by phw

Replying to karsten:

I wonder, should we even mention Tornado in the installation instructions? For development purposes it's sufficient to use a URL like file:///Users/karsten/src/atlas/index.html, and the deployed Atlas uses Apache, not Tornado. I'd say it's fine to remove Tornado and suggest the file:/// URL or a web server of choice with the Atlas directory as document root.

I think that's an even better solution. It would also "fix" #9085. The file:/// path only seems to work with Firefox, though. Chrome says that "Cross origin requests are only supported for HTTP". Either way, it's probably unnecessary to ship a web server together with the code.

phw, if you're trying to remove "TorStatus" instances from the code, also run: git grep "Tor Status"

Yes, I can take care of that. I guess it would also make sense to change the logo from "TorStatus" to "Atlas". At least I found the dual naming to be confusing in the beginning.

comment:6 in reply to:  5 ; Changed 7 years ago by karsten

Replying to phw:

Replying to karsten:

I wonder, should we even mention Tornado in the installation instructions? For development purposes it's sufficient to use a URL like file:///Users/karsten/src/atlas/index.html, and the deployed Atlas uses Apache, not Tornado. I'd say it's fine to remove Tornado and suggest the file:/// URL or a web server of choice with the Atlas directory as document root.

I think that's an even better solution. It would also "fix" #9085. The file:/// path only seems to work with Firefox, though. Chrome says that "Cross origin requests are only supported for HTTP". Either way, it's probably unnecessary to ship a web server together with the code.

Ah, didn't know this is Firefox only. But yes, we can probably expect that people will figure out how to set up a web server and serve some static files.

phw, if you're trying to remove "TorStatus" instances from the code, also run: git grep "Tor Status"

Yes, I can take care of that. I guess it would also make sense to change the logo from "TorStatus" to "Atlas". At least I found the dual naming to be confusing in the beginning.

Yes, please do. (That's probably a new ticket, but I figured I'd mention it here, because you renamed TorStatus to Atlas in that commit.)

comment:7 in reply to:  6 ; Changed 7 years ago by phw

Replying to karsten:

Replying to phw:

Replying to karsten:

phw, if you're trying to remove "TorStatus" instances from the code, also run: git grep "Tor Status"

Yes, I can take care of that. I guess it would also make sense to change the logo from "TorStatus" to "Atlas". At least I found the dual naming to be confusing in the beginning.

Yes, please do. (That's probably a new ticket, but I figured I'd mention it here, because you renamed TorStatus to Atlas in that commit.)

I created the following ticket for it: https://trac.torproject.org/projects/tor/ticket/9370

comment:8 in reply to:  7 ; Changed 7 years ago by karsten

Status: needs_reviewneeds_revision

Replying to phw:

I created the following ticket for it: https://trac.torproject.org/projects/tor/ticket/9370

Thanks! I assume the branch mentioned above needs a revision once #9370 is merged, right? Changing to needs_revision.

comment:9 in reply to:  8 Changed 7 years ago by phw

Replying to karsten:

Replying to phw:

I created the following ticket for it: https://trac.torproject.org/projects/tor/ticket/9370

Thanks! I assume the branch mentioned above needs a revision once #9370 is merged, right? Changing to needs_revision.

#9370 is merged now. And yes, it will need a revision. I will get to it in a day or two.

comment:10 Changed 7 years ago by phw

It took me a little bit longer than announced but the new changes are in the branch "bug_7844" in https://gitweb.torproject.org/user/phw/atlas.git

comment:11 Changed 7 years ago by karsten

Resolution: fixed
Status: needs_revisionclosed

Looks good to me. Merged to master. I didn't redeploy, because nothing of this should affect atlas.tpo. Closing. Thanks!

Note: See TracTickets for help on using tickets.