vfm

README

vfm

main branch is unstable, see tagged versions in releases

This project is part of a monorepo (https://github.com/CurtisNewbie/moon-monorepo).

vfm stands for virtual file manager. vfm doesn't manage the actual file storage, the actual files are stored by mini-fstore.

Requirements

• event-pump
• user-vault
• mini-fstore
• MySQL
• Consul
• Redis
• RabbitMQ

Configuration

Check miso.

Property	Description	Default Value
vfm.temp-path	Temporary file path for bootmarks files	/tmp/vfm
vfm.site.host	Externally accessible host

Updates

• Since v0.0.4, vfm relies on evnet-pump to listen to the binlog events. Whenever a new file_info record is inserted, the event-pump sends MQ to vfm, which triggers the image compression workflow if the file is an image.
• Since v0.0.8, Users can only share files using vfolder, field file_info.user_group and table file_sharing are deprecated.
• Since v0.1.3, fantahsea has been merged into vfm codebase, see Fantahsea Migration.
• Since v0.1.17, file tag functionality is removed.

Maintenance

Calculate size of all directories recursively, bubbling up to the root:

curl -X POST "http://localhost:8086/compensate/dir/calculate-size"

Compensate thumbnail generations, those that are images/videos (guessed by names) are processed to generate thumbnails:

curl -X POST "http://localhost:8086/compensate/thumbnail"

Schema Migration

Everytime the schema is changed, a new SQL script for that specific version is maintained at internal/schema/scripts. The migration is automatically handled by github.com/curtisnewbie/svc.

Doc

• HTTP API Doc
• Thumbnail Generation

Updates

• Since v0.1.19, vfm will migrate schema automatically using github.com/curtisnewbie/svc.
• Since v0.1.20, vfm has merged github.com/curtisnewbie/doc-indexer codebase.