Skip to content

Commit a2c032e

Browse files
authored
Update README.md
1 parent d3578e9 commit a2c032e

File tree

1 file changed

+40
-17
lines changed

1 file changed

+40
-17
lines changed

README.md

Lines changed: 40 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,76 @@
11
# Gokapi
2+
23
[![Documentation Status](https://readthedocs.org/projects/gokapi/badge/?version=latest)](https://gokapi.readthedocs.io/en/stable/?badge=stable)
34
[![Go Report Card](https://goreportcard.com/badge/github.com/forceu/gokapi)](https://goreportcard.com/report/github.com/forceu/gokapi)
4-
<a href='https://github.com/jpoles1/gopherbadger' target='_blank'>![gopherbadger-tag-do-not-edit](https://img.shields.io/badge/Go%20Coverage-83%25-brightgreen.svg?longCache=true&style=flat)</a>
5+
[![Coverage](https://img.shields.io/badge/Go%20Coverage-83%25-brightgreen.svg?longCache=true&style=flat)](https://github.com/jpoles1/gopherbadger)
56
[![Docker Pulls](https://img.shields.io/docker/pulls/f0rc3/gokapi.svg)](https://hub.docker.com/r/f0rc3/gokapi/)
67

8+
**Gokapi** is a simple, self-hosted file sharing server with automatic expiration and encryption support — ideal for teams or individuals who want privacy, control, and no clutter.
79

810
### Available for:
911

10-
- Bare Metal
11-
- [Docker](https://hub.docker.com/r/f0rc3/gokapi)
12+
- **Bare Metal** (Linux/macOS/Windows)
13+
- **Docker**: [View on Docker Hub](https://hub.docker.com/r/f0rc3/gokapi)
1214

13-
## About
15+
## Features
1416

15-
Gokapi is a lightweight server to share files, which expire after a set amount of downloads or days. It is similar to the discontinued [Firefox Send](https://github.com/mozilla/send), with the difference that only the admin is allowed to upload files.
17+
- **Expiring file shares:** Automatically removed after a set number of downloads or days
18+
- **User management with roles:** Fine-grained permission control, only registered users can upload
19+
- **File deduplication:** Identical files use no extra space
20+
- **Cloud storage support:** AWS S3 (or S3 compatible like Backblaze B2), optional
21+
- **Built-in encryption:** Including end-to-end encrypted uploads
22+
- **OpenID Connect support:** Integrate with identity providers like Authelia or Keycloak
23+
- **REST API:** For automation and integration into other systems
24+
- **Customizable UI:** Adjust look and feel with custom CSS and JavaScript
1625

17-
This enables companies or individuals to share their files very easily and having them removed afterwards, therefore saving disk space and having control over who downloads the file from the server.
1826

19-
Identical files will be deduplicated. An API is available to interact with Gokapi. AWS S3 and Backblaze B2 can be used instead of local storage. Customization is very easy with HTML/CSS knowledge. Encryption including end-to-end encryption is available.
27+
## Screenshots
28+
**File Overview**
2029

30+
<a href="https://github.com/user-attachments/assets/188ab076-6bed-43fc-a3d1-3d91f2ccdf0c" target="_blank">
31+
<img src="https://github.com/user-attachments/assets/188ab076-6bed-43fc-a3d1-3d91f2ccdf0c" width="300" />
32+
</a>
2133

22-
## Screenshots
23-
Admin Menu ![image](https://github.com/Forceu/Gokapi/assets/1593467/faf1f45a-de86-4698-ace1-7b64673ab67a)
34+
**API Overview**
2435

36+
<a href="https://github.com/user-attachments/assets/dc0ace44-1c0b-4eb6-afd2-0cb11db173b3" target="_blank">
37+
<img src="https://github.com/user-attachments/assets/dc0ace44-1c0b-4eb6-afd2-0cb11db173b3" width="300" />
38+
</a>
39+
40+
**User Overview**
2541

42+
<a href="https://github.com/user-attachments/assets/e808a20b-6cfc-472b-b539-f57c2001d822" target="_blank">
43+
<img src="https://github.com/user-attachments/assets/e808a20b-6cfc-472b-b539-f57c2001d822" width="300" />
44+
</a>
2645

27-
Download Link ![image](https://github.com/Forceu/Gokapi/assets/1593467/d26d0642-4f85-47f9-ae69-50c3b8bc7717)
46+
**Download Link**
2847

48+
<a href="https://github.com/Forceu/Gokapi/assets/1593467/d26d0642-4f85-47f9-ae69-50c3b8bc7717" target="_blank">
49+
<img src="https://github.com/Forceu/Gokapi/assets/1593467/d26d0642-4f85-47f9-ae69-50c3b8bc7717" width="300" />
50+
</a>
2951

3052

3153

3254

3355

3456

35-
## Installation
3657

37-
Can be deployed in only a few seconds. Please refer to the [documentation](https://gokapi.readthedocs.io/en/latest/setup.html)
58+
## Getting Started
3859

39-
## Usage
60+
You can deploy Gokapi in seconds using Docker or directly on your system.
4061

41-
Please refer to the [documentation](https://gokapi.readthedocs.io/en/latest/usage.html)
62+
[Installation Guide](https://gokapi.readthedocs.io/en/latest/setup.html)
63+
[Usage Instructions](https://gokapi.readthedocs.io/en/latest/usage.html)
64+
65+
## License
66+
67+
This project is licensed under the AGPL3 - see the [LICENSE.md](LICENSE.md) file for details
4268

4369
## Contributors
4470
<a href="https://github.com/forceu/gokapi/graphs/contributors">
4571
<img src="https://contributors-img.web.app/image?repo=forceu/gokapi" />
4672
</a>
4773

48-
## License
49-
50-
This project is licensed under the AGPL3 - see the [LICENSE.md](LICENSE.md) file for details
5174

5275

5376
## Donations

0 commit comments

Comments
 (0)