### Navigation

- index
- next |
- previous |
- Django FileBrowser v3.4.0 documentation »

# Quick start guide

For using the FileBrowser, Django needs to be installed and an Admin Site has to be activated.

## Requirements

- Django 1.3, http://www.djangoproject.com
- Grappelli 2.3, https://github.com/sehmaschine/django-grappelli
- PIL, http://www.pythonware.com/products/pil/

## Download

Using `pip`:

    pip install django-filebrowser

Go to https://github.com/sehmaschine/django-filebrowser if you need to download a package or clone the repo.

## Installation

Changed in version 3.4.0.

Open `settings.py` and add `filebrowser` to your `INSTALLED_APPS` (before `django.contrib.admin`):

    INSTALLED_APPS = (
        'grappelli',
        'filebrowser',
        'django.contrib.admin',
    )

In your `url.py` import the default FileBrowser site:

    from filebrowser.sites import site

and add the following URL-patterns (before any admin-urls):

    urlpatterns = patterns('',
       url(r'^admin/filebrowser/', include(site.urls)),
    )

Collect the media files:

    python manage.py collectstatic

Note

Please refer to the Staticfiles Documentation for setting up and using `staticfiles`.

## Testing

Run the FileBrowser tests:

    python manage.py test filebrowser

Start the devserver and login to your admin site:

    python manage.py runserver <IP-address>:8000

Goto `/admin/filebrowser/browse/` and check if everything looks/works as expected. If you’re having problems, see Troubleshooting.

### Navigation

- index
- next |
- previous |
- Django FileBrowser v3.4.0 documentation »