New instructions + minor URI fix #11
Conversation
| 1. Clone the repo to the server | ||
| 2. Create an installation location (E.G. `/var/www/files/`) | ||
| 3. Copy the `css`, `image`, `js` directories to the installation location | ||
| 4. Copy the `index.html` to the installation location |
There was a problem hiding this comment.
up until here, we can just do it in one step of: "clone the repo under /var/www/files/ or any directory you want to install the file browser's web UI from". WDYT?
also I would argue that choosing directory name files/ for web UI, which in default setup is used for the listed files is a confusing choice. what about something like /var/www/ui/?
| 3. Copy the `css`, `image`, `js` directories to the installation location | ||
| 4. Copy the `index.html` to the installation location | ||
| 5. Create the location for the files to be shared & browsable (E.G. `/var/www/isos`) | ||
| 6. Copy the files to the location |
There was a problem hiding this comment.
technically seen, you don't need to copy. for many use cases copying (probably gigabytes of data) is not an option. so either copy or using a symlink (which is described a at the end of this doc).
| @@ -8,6 +8,39 @@ effectively together with [nginx's autoindex module](http://nginx.org/en/docs/ht | |||
|
|
|||
| A sample nginx configuration is also included which mounts **file browser** under root (`/`) and mounts files to be listed under `/files` path. Hence is the `filesBaseUrl` under | |||
|
|
|||
| ## Installation / Configuration | |||
|
|
|||
| The system has a default to use the location's root (E.G. the site's root location `www.example.net/`, and the physical of `/opt/www/`). This can be configured to move both the ***installation*** location and the location to be browseable. | |||
There was a problem hiding this comment.
well we are talking about the "file browser UI location" and "listed files location". I would say lets adjust the wording to keep it consistent over the whole doc.
| 4. Copy the `index.html` to the installation location | ||
| 5. Create the location for the files to be shared & browsable (E.G. `/var/www/isos`) | ||
| 6. Copy the files to the location | ||
| 7. Make sure the files in the installation location & the location for the files to be shared are owned by the nginx process (E.G. `www-data:www-data` for Debian/Ubuntu based saystems) |
There was a problem hiding this comment.
is owning required? I think being able to read files and list the directories should be enough.
There was a problem hiding this comment.
It only must be readable by www-data, being owned by it is overkill. Maybe this can be worded as:
7. Make sure both the UI and shared files are at least readable by the nginx process[...] with `chmod +r -R ...`, and directories are browseable: `chmod +x ...`. Or make `www-data` own the files and directories: `chown -R www-data: ...`There was a problem hiding this comment.
this is definitely better, we just need someone to update the PR :)
| @@ -8,6 +8,39 @@ effectively together with [nginx's autoindex module](http://nginx.org/en/docs/ht | |||
|
|
|||
| A sample nginx configuration is also included which mounts **file browser** under root (`/`) and mounts files to be listed under `/files` path. Hence is the `filesBaseUrl` under | |||
|
|
|||
| ## Installation / Configuration | |||
There was a problem hiding this comment.
I understand that in your use case a direct installation was probably a better choice, however in all these years I have been using this as an docker image (and that should remain the main focus). So it would be a good point to highlight that there are multiple options on how to use this and one is using the docker image and other is this direct installation.
Lets add a title called ## Usage under which we will have the ### Using with Docker and then this part under ### Direct Installation after that.
Had a hair pulling moment trying to work out why it wouldnt 'install' on my system. Eventually worked out how it all fits together, so I wrote a quick instruction set (based on Debian/Ubuntu).
Also fixed the URI for the font, as it was missing the HTTP or HTTPS from the URI. Set to HTTPS to be secure and allow for cross style loading correctly.