'Generic Commit'
This commit is contained in:
46
README.md
46
README.md
@@ -3,13 +3,6 @@
|
|||||||
A simple object storage system that stores files with metadata and provides a REST API for access.
|
A simple object storage system that stores files with metadata and provides a REST API for access.
|
||||||
|
|
||||||
|
|
||||||
## Install
|
|
||||||
|
|
||||||
To install the latest version of simple-object-server, run:
|
|
||||||
```bash
|
|
||||||
curl https://getbin.xyz/simple-object-server-install | bash
|
|
||||||
```
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- Store files with metadata (label:tag pairs and custom fields)
|
- Store files with metadata (label:tag pairs and custom fields)
|
||||||
@@ -25,22 +18,6 @@ curl https://getbin.xyz/simple-object-server-install | bash
|
|||||||
- CORS support for web applications
|
- CORS support for web applications
|
||||||
- Rate limiting for security
|
- Rate limiting for security
|
||||||
|
|
||||||
## Building
|
|
||||||
|
|
||||||
To build output/simple-object-server for the current architecture run:
|
|
||||||
```bash
|
|
||||||
./build.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
To build and test the docker image gitea.jde.nz/public/simple-object-server:test, run:
|
|
||||||
```bash
|
|
||||||
./test.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
To build for multiple architectures, and publish the combined docker image to gitea.jde.nz, run:
|
|
||||||
```bash
|
|
||||||
./publish.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
### Running with Docker
|
### Running with Docker
|
||||||
|
|
||||||
@@ -82,6 +59,12 @@ Then run:
|
|||||||
```bash
|
```bash
|
||||||
docker-compose up -d
|
docker-compose up -d
|
||||||
```
|
```
|
||||||
|
## Manual Install
|
||||||
|
|
||||||
|
To install the latest version of simple-object-server, run:
|
||||||
|
```bash
|
||||||
|
curl https://getbin.xyz/simple-object-server-install | bash
|
||||||
|
```
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
@@ -106,6 +89,23 @@ The server can be configured by creating a JSON configuration file at `~/.config
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Building
|
||||||
|
|
||||||
|
To build output/simple-object-server for the current architecture run:
|
||||||
|
```bash
|
||||||
|
./build.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
To build and test the docker image gitea.jde.nz/public/simple-object-server:test, run:
|
||||||
|
```bash
|
||||||
|
./test.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
To build for multiple architectures, and publish the combined docker image to gitea.jde.nz, run:
|
||||||
|
```bash
|
||||||
|
./publish.sh
|
||||||
|
```
|
||||||
|
|
||||||
## API Endpoints
|
## API Endpoints
|
||||||
|
|
||||||
### Upload a File
|
### Upload a File
|
||||||
|
Reference in New Issue
Block a user