SFE4J

Simple File Explorer for spring-boot based Java Web Application.

Features

• List the directories/files in a specific directory, include detailed information:
  • Permission
  • Size
  • Date Modified
• Supported Actions:
  • View text/logs/html online
  • Download files
• Can specific the default directory
• Can restrict the access to a specified directory
• Can configure title/description of the page
• Can configure quick links
• More features are coming ...

Usage

Scenario 1. Integrate sfe4j to spring-boot based applications

Add repositories

Add the below repository configuration to pom.xml of your project or settings.xml of Maven.

<repository>
    <id>sfe4j</id>
    <url>https://raw.github.com/sfe4j/mvn-repo/master</url>
</repository>

Add dependencies

Add the below dependency configuration to pom.xml of your project.

<dependency>
    <groupId>com.amoylabs</groupId>
    <artifactId>sfe4j-spring-boot-starter</artifactId>
    <version>${sfe4j-spring-boot-starter-version}</version>
</dependency>

Latest Version:

    <sfe4j-spring-boot-starter-version>0.0.10</sfe4j-spring-boot-starter-version>

Configure properties

prefix

sfe4j

properties

key	allowed value	default value	description
title	String	"SFE4J"	Title of the file-explorer page.
description	String	"Simple File Explorer for spring-boot based Java Web Application."	Description of the file-explorer page.
quick-links	Map	N/A	Quick links showed on top-left of the file-explorer page, e.g. root: "/" logs: "/data/logs"
base-dir-path	String	"/"	Full path of base directory, e.g. "c:/" for Windows, "/" for Linux or MacOS.
restrict-to-base-dir	Boolean	false	Whether restrict the access to base directory only or not.

example

sfe4j:
  title: "SFE4J Demo"
  description: "Simple File Explorer for spring-boot based Java Web Application."
  quick-links:
    root: "/"
    logs: "/data/logs"
  base-dir-path: "/data"
  restrict-to-base-dir: true

Entrypoint

http://localhost:8080/file-explorer

Scenario 2. Deploy sfe4j to docker

sfe4j was deployed to docker hub. Please refer to: https://hub.docker.com/r/sfe4j/sfe4j

Example Command to run sfe4j in docker

docker run -d -p28080:28080 sfe4j/sfe4j

Example URL to access SFE4J

http://localhost:28080/file-explorer

Environment Variables

Please refer to https://hub.docker.com/r/sfe4j/sfe4j for all availabe environment variables.

Scenario 3. Deploy sfe4j as a sidecar of applications in Kubernetes

Examples

      containers:
        - name: sfe4j
          image: sfe4j/sfe4j
          ports:
            - name: http
              containerPort: 28080
          env:
            - name: TITLE
              value: "SFE4J"
            - name: BASE_DIR_PATH
              value: "/data"

Example URL to access SFE4J

http://INGRESS_HOST:INGRESS_PORT/file-explorer

Environment Variables

Please refer to https://hub.docker.com/r/sfe4j/sfe4j for all availabe environment variables.

Demo

Live demo

Link: https://sfe4j-demo.amoylabs.com:30443/file-explorer

Screenshot

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

GNU Affero General Public License v3.0