Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update to README for Improved Clarity and Organization #17

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Update to README for Improved Clarity and Organization #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
71ec71d
Update README
UnitedPenguin Aug 5, 2023
4b06b21
Delete README
UnitedPenguin Aug 5, 2023
60cbd0a
Create README.md
UnitedPenguin Aug 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 0 additions & 57 deletions README
View file
Open in desktop

This file was deleted.

57 changes: 57 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# pingfs - "True Cloud Storage"

[![License: ISC](https://img.shields.io/badge/License-ISC-blue.svg)](https://opensource.org/licenses/ISC) [![Linux Compatible](https://img.shields.io/badge/Linux-Compatible-brightgreen.svg)](https://shields.io/)

Developed by Erik Ekman ([email protected])

## Introduction

Pingfs is an innovative filesystem where the data is stored within the Internet itself, utilizing ICMP Echo packets (pings) that travel between your machine and remote servers.

## Compatibility & Requirements

Pingfs is designed for Linux, as portability is not an objective of this project. The filesystem is implemented using raw sockets and FUSE, hence superuser access is necessary. The application supports both IPv4 and IPv6 remote hosts.

## Building and Installation

To compile the application, simply use the `make` command in your terminal.

## Usage

### Getting Started:

1. Compile the project by running the `make` command.
2. Create a text file containing the hostnames and IP addresses to target.
3. As root, run the command `./pingfs <filename> <mountpoint>`. This will resolve all hostnames and test each resolved address for its responsiveness to pings. After this, the filesystem will be mounted.
4. Pingfs will remain active in the foreground and provide stats on packets and bytes each second.

### Halting the Process:

- Pingfs can be stopped with ^C command, and it should unmount itself.
- If this does not work, you can manually unmount with `fusermount -u <mountpoint>`.

## Features

### Supported Operations:

- Creation and removal of regular files.
- File listing.
- File renaming.
- Reading, writing, and truncating files.
- Setting and getting file permissions.

### Unsupported Operations:

- Creation and removal of directories.
- Creation of soft/hard links.
- Timestamps (they are always 0).

## Notes

The current performance of Pingfs is not sufficient to handle LAN hosts, as it may lose data immediately. Please use Pingfs with caution.

## License

Pingfs is released under the ISC License by Erik Ekman from 2013-2023.

Please be aware that this software is provided as is, and the author disclaims all warranties with regard to this software including all implied warranties of merchantability and fitness. In no event shall the author be liable for any special, direct, indirect, or consequential damages or any damages whatsoever resulting from loss of use, data or profits, whether in an action of contract, negligence or other tortious action, arising out of or in connection with the use or performance of this software.