https://github.com/testinggospels/camouflage-filemanager
Camouflage Filemanager is a web based filemanager that allows you to browse files/folders, edit text based files, upload and download files.
https://github.com/testinggospels/camouflage-filemanager
camouflage explorer-filemanager filemanager filemanager-ui hacktoberfest sveltekit
Last synced: 6 months ago
JSON representation
Camouflage Filemanager is a web based filemanager that allows you to browse files/folders, edit text based files, upload and download files.
- Host: GitHub
- URL: https://github.com/testinggospels/camouflage-filemanager
- Owner: testinggospels
- License: mit
- Created: 2021-10-02T05:49:33.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-11-06T04:02:56.000Z (over 3 years ago)
- Last Synced: 2024-11-29T06:11:04.767Z (6 months ago)
- Topics: camouflage, explorer-filemanager, filemanager, filemanager-ui, hacktoberfest, sveltekit
- Language: Svelte
- Homepage: https://camouflage-filemanager.herokuapp.com/
- Size: 109 KB
- Stars: 18
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Camouflage Filemanager
Camouflage Filemanager is a web based filemanager that allows you to browse and create files/folders, edit text based files, download files.
## Preview
## Installation
### NPM
```bash
npm install -g camouflage-filemanager
```
Filemanager requires two environment variables
* `FS_ROOT`: Root Directory for filemanager; default value is current working directory
* `WRITE_PROTECTED`: Default value is `true`, which means creation/deletion/updates of any kind are not allowed.
Start filemanager after npm installation by running command: `filemanager` in your desired directory. Optionally you can override aforementioned environment variables by exporting or by creating a `.env` file in your current working directory.
### Docker
1. Default:
```bash
docker run -d -p 3000:3000 --name filemanager shubhendumadhukar/camouflage-filemanager
```
2. Specify root directory:
```bash
docker run -d -p 3000:3000 -e FS_ROOT="/opt" --name filemanager shubhendumadhukar/camouflage-filemanager
```
3. Specify if write is allowed (not allowed by default):
```bash
docker run -d -p 3000:3000 -e FS_ROOT="/opt" -e WRITE_PROTECTED=false --name filemanager shubhendumadhukar/camouflage-filemanager
```
4. Mount a local volume:
```bash
docker run -d -p 3000:3000 -e FS_ROOT="/opt/virtual_services" -e WRITE_PROTECTED=false -v ~/Desktop:/opt/Desktop --name filemanager shubhendumadhukar/camouflage-filemanager
```
## License
```
MIT License
Copyright (c) 2021 testinggospels
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```