Commits

Owen Nelson committed 2b9f6a2

fixes #8

Comments (0)

Files changed (2)

 `Lance Spitzner <http://www.securingthehuman.org/>`_
 in which he described his approach to phishing awareness.
 
-Trawler requires ``django>=1.3`` and the ability to send mail.
-Here's the highlights of how to get up and running.
+For more detail: http://django-trawler.readthedocs.org/
 
-* Add ``trawler`` to ``INSTALLED_APPS``.
-* Run django's ``syncdb`` management command.
-* Ensure your mail settings are appropriate (the app needs to send mail, 
-  or not if in development).
-* Enable the admin site to use the trawler interface.
-* Ensure you set the domain for your server (django ``Sites`` framework) so 
+Installation
+------------
+If you're familiar with django apps, this process will be familiar.
+Install using your choice of ``pip`` or ``easy_install``: ::
+    
+    $ pip install django-trawler
+    
+    or ...
+    
+    $ easy_install django-trawler
+
+
+Configuration
+-------------
+
+In your project settings module:
+
+* Add ``trawler`` and ``django.contrib.admin``  to ``INSTALLED_APPS``.
+* Ensure your mail settings are appropriate (the app needs to send mail).
+* Ensure you set the domain for your server (django ``Sites`` framework) so
   admin links point to the right place.
 * Include ``trawler.urls`` in your urlconf.
-* **MAKE ABSOLUTELY SURE** ``DEBUG = False`` before launching a campaign (or your 
+* **MAKE ABSOLUTELY SURE** ``DEBUG = False`` before launching a campaign (or your
   *targets* will see nice django 404 pages).
 
-For more detail: http://django-trawler.readthedocs.org/

docs/getting_started.rst

 Installation
 ------------
 If you're familiar with django apps, this process will be fairly natural.
-I'm not planning on pushing this project to PyPI until the code has been 
-**tested** thoroughly **in production**, so for now installation should be handled
-directly from the repo. 
+Install using your choice of ``pip`` or ``easy_install``: ::
+    
+    $ pip install django-trawler
+    
+    or ...
+    
+    $ easy_install django-trawler
 
-From the repo
-^^^^^^^^^^^^^
-This section expects you to have a basic familiarity with `pip <http://www.pip-installer.org/>`_, 
-`virtualenv <http://www.virtualenv.org/>`_, and optionally 
-`virtualenvwrapper <http://www.doughellmann.com/projects/virtualenvwrapper/>`_ (recommended).
 
-.. Hiding the below block until the project has been sent to PyPI.
-   From PyPI
-   ^^^^^^^^^
-   Once this package has been pushed out to PyPI, simply naming the package will 
-   do the trick:  
+Configuration
+-------------
 
-   ``easy_install django-trawler`` or ``pip install django-trawler``
+In your project settings module:
 
-Using ``pip``, you can install directly from the repo.
-
-``pip install hg+https://bitbucket.org/onelson/django-trawler#egg=django-trawler`` 
-
-If you're like me (hacking on the package itself), my recommendation is to setup 
-a virtualenv, clone the project repo, then run ``python setup.py develop``. 
-Theres a small test project/site that can be used to run the code included with 
-the project, so you'll be all set. 
-
-Here's an example using pip+virtualenv+virtualenvwrapper: ::
-
-	owen@enso:~/workspace$ mkvirtualenv foo
-	... snip ...
-	(foo)owen@enso:~/workspace$ hg clone https://bitbucket.org/onelson/django-trawler my_trawler
-	... snip ...
-	(foo)owen@enso:~/workspace$ cd my_trawler/
-	(foo)owen@enso:~/workspace/my_trawler$ ls
-	docs  pylintrc  setup.py  test_proj  trawler
-	(foo)owen@enso:~/workspace/my_trawler$ python setup.py develop
-	running develop
-	running egg_info
-	... snip ...
-	Finished processing dependencies for django-trawler==0.1a
-	(foo)owen@enso:~/workspace/my_trawler$
-
-It's worth noting that while working with the selected virtualenv, ``python`` is
-the executable based in the virtualenv, so when you run ``python setup.py develop``
-it's creating a link in your virtualenv's site-packages (not your global system's).
-
-Once this link is created, you can run ``python manage.py [...]`` in the ``test_proj``
-directory and that project should be able to *find* the trawler code in the ``sys.path``.
-
-Post-Install Configurations
----------------------------
-Django itself is listed as a dependency in trawler's setup.py, so regardless of 
-the installation source or method, you should have everything you need in place 
-to fire up the app. All that is required of you is the customization of a few 
-key settings in the ``test_proj/settings.py`` (or your own, if you're deploying 
-**for reals**). Here are the highlights...
-
-* Add ``trawler`` to ``INSTALLED_APPS``.
-* Ensure your mail settings are appropriate (the app needs to send mail, 
-  or not if in development).
-* Enable the admin site to use the trawler interface.
+* Add ``trawler`` and ``django.contrib.admin``  to ``INSTALLED_APPS``.
+* Ensure your mail settings are appropriate (the app needs to send mail).
 * Ensure you set the domain for your server (django ``Sites`` framework) so 
   admin links point to the right place.
 * Include ``trawler.urls`` in your urlconf.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.