Skip to main content

FTP server application for Django.

Project description

build-status pypi python-version docs

FTP server application that used user authentication of Django.

Getting Started

  1. Install django-ftpserver by pip.

$ pip install django-ftpserver
  1. Add line to settings.INSTALLED_APPS for your django project.

INSTALLED_APPS = (
    # ..
    'django_ftpserver',
)
  1. Migrate app.

$ python manage.py migrate
  1. Create FTP user group.

$ python manage.py createftpusergroup my-ftp-group
  1. Create FTP user account.

$ python manage.py createftpuseraccount <username> my-ftp-group

<username> is the django authentication username.

  1. Run manage.py ftpserver command.

$ python manage.py ftpserver 127.0.0.1:10021
  1. Connect with your favorite FTP client.

Requirements

  • Target Python version is 3.6, 3.7, 3.8, 3.9, 3.10

  • Django>=2.2

  • pyftpdlib

License

This software is licensed under the MIT License.

Documentation

The latest documentation is hosted at Read The Docs.

https://django-ftpserver.readthedocs.org/en/latest/

Develop

This project is hosted at Github: https://github.com/tokibito/django-ftpserver

Author

  • Shinya Okano

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page