search

nocpiun / ferrum

🌏 Explore throughout your server
https://ferrum-demo.nin.red
MIT License
9 stars 2 forks source link
file-explorer file-manager nextjs react typescript web-based

readme

# Ferrum Explorer [![Author](https://img.shields.io/badge/Author-NriotHrreion-red.svg "Author")](https://github.com/NriotHrreion) [![LICENSE](https://img.shields.io/badge/license-MIT-blue.svg "LICENSE")](./LICENSE) [![Stars](https://img.shields.io/github/stars/nocpiun/ferrum.svg?label=Stars)](https://github.com/nocpiun/ferrum/stargazers) [![test](https://img.shields.io/github/actions/workflow/status/nocpiun/ferrum/ci.yml)](https://github.com/nocpiun/ferrum/actions/workflows/ci.yml) [![Netlify Status](https://api.netlify.com/api/v1/badges/4bbf93a7-63d0-4512-bb3a-09345632ad1e/deploy-status)](https://app.netlify.com/sites/inspiring-torte-1d7e94/deploys) > Explore throughout your server

Description

Ferrum Explorer is a web-based file explorer app for servers.

Because it's only maintained by me, so it might have some problems and bugs. You can raise an issue or create a pull request to tell me or fix it.

Why its name is Ferrum?

File Explorer -> FE -> Fe (Chemical Element) -> Ferrum

May I have a look?

Demo Site (Default password is 123456)

Deploy & Use

First, you need to make sure that your server (or computer) has installed Nodejs.

  1. Download and install
git clone https://github.com/nocpiun/ferrum.git
cd ferrum
npm i
npm run patch
npm run build
  1. Prepare the .pwd file

Rename the .pwd.example to .pwd in the project root folder. This file stores your access key to Ferrum. The default password is 123456, and you can change your password in the settings.

PASSWORD=....
  1. Run the app (Recommended to use Administrator privilege)
npm run start
  1. Enter http://localhost:3300

To get update

Do the following commands, then do npm run start.

git fetch origin main:temp
git merge temp
npm i

Something to notice

Ferrum Explorer requires ports 3300 to launch. If you see it reports address already in use :::xxxx, you should have a check to whether you've launched Ferrum Explorer and whether other apps are using the ports. And see the following steps.

Windows

netstat -aon | findstr [[here write the port it reported]]
taskkill /f /pid [[here write the PID the above command returned]]

Linux & Mac OS

lsof -i:[[here write the port it reported]]
kill -9 [[here write the PID the above command returned]]

Contributing

Contributions to Ferrum Explorer are welcomed. You can fork this project and start your contributing. If you don't know how to do, please follow the instruction Creating a Pull Request from a Fork.

I'll check the Pull Request list in my spare time. I can't make sure that every Pull Request will be seen by me at once.

Scripts

An explanation of the package.json scripts.

LICENSE

MIT