https://github.com/blackglory/refile

🌲
https://github.com/blackglory/refile

docker-image esm microservice nodejs typescript

Last synced: 6 months ago
JSON representation

🌲

Host: GitHub
URL: https://github.com/blackglory/refile
Owner: BlackGlory
License: mit
Created: 2022-10-02T02:42:00.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-02-15T07:48:19.000Z (about 2 years ago)
Last Synced: 2025-02-21T12:43:37.428Z (about 1 year ago)
Topics: docker-image, esm, microservice, nodejs, typescript
Language: TypeScript
Homepage: https://hub.docker.com/r/blackglory/refile
Size: 2.55 MB
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

# Refile
提供基于HTTP的文件管理服务, 受到IPFS启发.

Refile的文件管理是基于内容寻址和引用计数进行的, 通过Refile上传的文件会失去它的文件名和MIME类型.

## Quickstart
```sh
docker run \
--detach \
--publish 8080:8080 \
blackglory
```

## Install
### 从源代码运行
```sh
git clone https://github.com/BlackGlory
cd log
yarn install
yarn build
yarn bundle
yarn --silent start
```

### 从源代码构建
```sh
git clone https://github.com/BlackGlory
cd refile
yarn install
yarn docker:build
```

### Recipes
#### docker-compose.yml
```yaml
version: '3.8'

services:
refile:
image: 'blackglory'
restart: always
volumes:
- 'refile-database:/database'
- 'reifle-storage:/storage'
ports:
- '8080:8080'

volumes:
refile-database:
refile-storage:
```

## API
所有API中的namespace和id都需要满足此正则表达式: `^[a-zA-Z0-9\.\-_]{0,255}$`

### upload file
`PUT /files/`

上传文件.

上传文件时需要提供三个参数:
- `file`:
需要上传的二进制文件, 由FormData的file字段提供.
一次只能上传一个文件, 表单的编码必须为`multipart/form-data`.
- `hashList`:
分段hash列表, 由ForumData的多个名为hashList的同名字段提供.
将文件按512KiB为切割点进行分段, 计算出每段内容的SHA-256,
将其16进制字符串形式保存为有序数组, 该数组即为文件的hashList.
- `hash`:
文件的最终hash, 在URL里提供.
将hashList的字符串连接起来, 计算其SHA-256, 其16进制字符串形式即为文件的最终hash.

被上传的文件必须先通过set reference建立相应的引用关系.
如果文件的引用数为零, 上传会被拒绝.
上传参数设计得如此复杂是为了能够尽早拒绝错误和重复的文件.

上传的文件原本不存在时, 返回HTTP状态码201.
上传的文件原本就已经存在时, 返回HTTP状态码204.
上传的文件的hash校验错误时, 返回HTTP状态码409.

### get file info
`GET /files/`

获取与资源相关的信息.

返回JSON:
```ts
{
hash: string
location: string | null // 未上传时, location为null
references: number
}
```

#### Example
##### curl
```sh
curl "http://localhost:8080/files/$hash"
```

##### JavaScript
```js
await fetch(`http://localhost:8080/files/${hash}`)
.then(res => res.json())
```

### get file location
`GET /files//location`

通过hash获取文件的location.
它与get file info的功能重合, 但性能更好.

如果location存在, 返回HTTP状态码200, 以文本形式返回location.
如果location不存在, 返回HTTP状态码404.

#### Example
##### curl
```sh
curl "http://localhost:8080/files/$hash/location"
```

##### JavaScript
```js
await fetch(`http://localhost:8080/files/${hash}/location`)
.then(res => res.text())
```

### set reference
`PUT /namespaces//items//files/`

设置文件hash与引用的关系.

#### Example
##### curl
```sh
curl \
--request PUT \
"http://localhost:8080/namespaces/$namespace/items/$id/files/$hash"
```

##### JavaScript
```js
await fetch(`http://localhost:8080/namespaces/${namespace}/items/${id}/files/${hash}`)
```

### remove reference
`DELETE /namespaces//items//files/`

移除文件hash与引用的关系.

#### Example
##### curl
```sh
curl \
--request DELETE \
"http://localhost:8080/namespaces/$namespace/items/$id/files/$hash"
```

##### JavaScript
```js
await fetch(`http://localhost:8080/namespaces/${namespace}/items/${id}/files/${hash}`, {
method: 'DELETE'
})
```

### remove references by item id
`DELETE /namespaces//items/`

移除特定项目的全部引用.

#### Example
##### curl
```sh
curl \
--request DELETE \
"http://localhost:8080/namespaces/$namespace/items/$id"
```

##### JavaScript
```js
await fetch(`http://localhost:8080/namespaces/${namespace}/items/${id}`, {
method: 'DELETE'
})
```

### remove references by namespace
`DELETE /namespaces/`

删除特定命名空间下的全部引用.

#### Example
##### curl
```sh
curl \
--request DELETE \
"http://localhost:8080/namespaces/$namespace"
```

##### JavaScript
```js
await fetch(`http://localhost:8080/namespaces/${namespace}`, {
method: 'DELETE'
})
```

### get all namespaces
`GET /namespaces`

获取所有命名空间.

返回JSON:
```ts
string[]
```

#### Example
##### curl
```sh
curl 'http://localhost:8080/namespaces'
```

##### JavaScript
```js
await fetch('http://localhost:8080/namespaces')
.then(res => res.json())
```

### get all item ids
`GET /namespaces//items`

获取特定命名空间下的所有项目id列表.

返回JSON:
```ts
string[]
```

#### Example
##### curl
```sh
curl "http://localhost:8080/namespaces/$namespace/items"
```

##### JavaScript
```js
await fetch(`http://localhost:8080/namespaces/${namespace}/items`)
.then(res => res.json())
```

### get file hashes by item id
`GET /namespaces//items//files`

获取与特定引用相关联的文件hash列表.

返回JSON:
```ts
string[]
```

#### Example
##### curl
```sh
curl "http://localhost:8080/namespaces/$namespace/items/$id/files"
```

##### JavaScript
```js
await fetch(`http://localhost:8080/namespace/${namespace}/items/${id}/files`)
.then(res => res.json())
```

### get item ids by file hash
`GET /files//namespaces//items`

获取特定命名空间下与特定文件相关的项目id列表.

返回JSON:
```ts
string[]
```

#### Example
##### curl
```sh
curl "http://localhost:8080/files/$hash/namespaces/$namespace/items"
```

##### JavaScript
```js
await fetch(`http://localhost:8080/files/${hash}/namespaces/${namespace}/items`)
.then(res => res.json())
```

### collect garbage
`POST /collect-garbage`

执行垃圾回收, 将引用数为0的文件从存储中删除.

#### Example
##### curl
```sh
curl 'http://localhost:8080/collect-garbage'
```

##### JavaScript
```js
await fetch('http://localhost:8080/collect-garbage', {
method: 'POST'
})
```

## 环境变量
### `REFILE_HOST`, `REFILE_PORT`
通过环境变量`REFILE_HOST`和`REFILE_PORT`决定服务器监听的地址和端口,
默认值为`localhost`和`8080`.

## 客户端
- JavaScript/TypeScript(Node.js, Browser):

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/blackglory/refile

Awesome Lists containing this project

README