[TASK] Add correct copyright header to all PHP files
[TYPO3CMS/Extensions/fal_webdav.git] / README.md
1 # File Abstraction Layer driver for WebDAV
2
3 This extension provides the necessary interfaces to connect a TYPO3 instance to a WebDAV storage. Files can then easily
4 be embedded into content or listed on the site.
5
6 Encrypted communication and user authentication for WebDAV are supported.
7
8 ## Setup
9
10 After downloading/cloning the extension, execute `composer install` in `Resources/Composer/`. This is required to get
11 the necessary third-party libraries for WebDAV communication.
12
13 After that, create a "File Storage" record (on the root page of your installation). Select "WebDAV" as the driver and
14 fill in the required details.
15
16 User authentication can either be done via the URL (`http://user:password@webdav.example.com/`) or in separate fields.
17 In both cases, the URLs that are displayed publicly do not contain authentication information.
18
19 ### A note on password-protected WebDAV storages
20
21 If your WebDAV requires authentication, do not mark the checkbox "Is publicly available?" in tab "Access". Otherwise,
22 links will point directly to it, requiring site visitors to enter the password.
23
24 In this case, you should also configure a different folder for the processed files, see setting "Folder for manipulated 
25 and temporary images etc.".
26
27 ## Developer information
28
29 ### Creating a ZIP file of the extension (for installation in EM)
30
31 Execute the following command in the folder:
32
33     zip -9 -r ../fal_webdav_<version>.zip . -x Resources/Php/* -x .git/* -x */.git/*
34
35 Replace `<version>` with the version, e.g. `1.0.0`. Suffixes like `beta`, `alpha`, `dev` can be appended using a slash, 
36 e.g. `0.2.0-dev` or `1.0.0-beta1`.
37
38 ## Contact
39
40 If you found a bug, create an issue on Github. If you need support or new features, drop me a line at
41 `dev (at) a-w dot io`.