Skip to content

Latest commit

 

History

History
64 lines (40 loc) · 1.84 KB

quickstart.rst

File metadata and controls

64 lines (40 loc) · 1.84 KB

Quick start guide

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

Requirements

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

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

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

Add URL-patterns (before any admin-urls):

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

Collect the media files:

python manage.py collectstatic

Note

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

If you're not using staticfiles you can either use a symlink from your media-directory (given by MEDIA_ROOT and MEDIA_URL) or copy the filebrowser media-files to your media-directory. Don't forget to change the settings accordingly.

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 :ref:`troubleshooting`.