Quick start guide

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

Installation

Install the FileBrowser:

pip install django-filebrowser

Add the filebrowser to your INSTALLED_APPS (before django.contrib.admin):

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

Add the FileBrowser site to your url-patterns (before any admin-urls):

from filebrowser.sites import site

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

Collect the static files (please refer to the Staticfiles Documentation for more information):

python manage.py collectstatic

Settings

Check the Settings.

Note

You need to add a folder “uploads” within site.storage.location when using the default settings. And we strongly recommend to define a VERSIONS_BASEDIR.

Testing

Run the FileBrowser tests:

python manage.py test filebrowser

Warning

Please note that the tests will copy files to your filesystem.

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.