https://github.com/raviteja-112/pinas
PiNAS is a web-based interface for managing files on a Raspberry Pi or any NAS device. Built with FastAPI, SQLAlchemy, and Jinja2, it enables browsing, uploading, and deleting files/directories via a user-friendly web interface.
https://github.com/raviteja-112/pinas
fastapi nas networkstorage raspberrypi sqlalchemy
Last synced: about 2 months ago
JSON representation
PiNAS is a web-based interface for managing files on a Raspberry Pi or any NAS device. Built with FastAPI, SQLAlchemy, and Jinja2, it enables browsing, uploading, and deleting files/directories via a user-friendly web interface.
- Host: GitHub
- URL: https://github.com/raviteja-112/pinas
- Owner: raviteja-112
- Created: 2025-06-12T09:41:05.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-12T16:12:58.000Z (about 1 year ago)
- Last Synced: 2025-06-20T02:05:24.980Z (about 1 year ago)
- Topics: fastapi, nas, networkstorage, raspberrypi, sqlalchemy
- Language: Python
- Homepage:
- Size: 9.77 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# PiNAS: Raspberry Pi Network Attached Storage Interface
A web-based interface for managing files on a Raspberry Pi or any network-attached storage (NAS) device. Built with FastAPI, SQLAlchemy, and Jinja2 templates, PiNAS allows users to browse, upload, and delete files and directories through a web interface.
## Features
- User authentication and session management
- File and directory browsing
- File upload functionality
- File and directory deletion
- Admin user management
- Configurable base directory for file operations
- Environment variable-based configuration
## Use Cases
- Simple file management for local directories
- Basic file sharing within a small team
- Lightweight alternative to more complex file management systems
## Installation
1. Clone the repository:
```bash
git clone https://github.com/raviteja-112/PiNAS.git
cd pinas
```
2. Create a virtual environment and activate it:
```bash
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
```
3. Install the required packages:
```bash
pip install -r requirements.txt
```
4. Create a `.env` file with the following content:
```
SESSION_SECRET_KEY=your-secure-secret-key
ADMIN_PASSWORD=your-secure-admin-password
BASE_PATH=/path/to/your/base/directory
```
5. Run the application:
```bash
uvicorn main:app --reload
```
6. Open your browser and navigate to `http://127.0.0.1:8000`
## Usage
1. Log in with the default admin credentials (username: `admin`, password: `your-secure-admin-password`)
2. Browse files and directories in the configured base path
3. Upload new files using the upload form
4. Delete files or directories using the delete button
5. Register new users (admin functionality)
## Configuration
The application can be configured using environment variables:
- `SESSION_SECRET_KEY`: Secret key for session management
- `ADMIN_PASSWORD`: Password for the default admin user
- `BASE_PATH`: Base directory for file operations
## Contributing
Contributions are welcome! Please open an issue or submit a pull request.
## License
This project is licensed under the MIT License.