https://github.com/ap4y/cloud

File sharing app for self hosted users
https://github.com/ap4y/cloud

gallery self-hosted sharing

Last synced: 2 months ago
JSON representation

File sharing app for self hosted users

• Host: GitHub
• URL: https://github.com/ap4y/cloud
• Owner: ap4y
• License: mit
• Created: 2019-08-05T01:50:32.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-02-25T00:35:47.000Z (almost 2 years ago)
• Last Synced: 2024-06-20T19:23:01.780Z (6 months ago)
• Topics: gallery, self-hosted, sharing
• Language: JavaScript
• Homepage:
• Size: 12.5 MB
• Stars: 6
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.org
  • License: LICENSE

Awesome Lists containing this project

README

        
* Cloud

*Cloud* is a web app that aims to simplify secure file sharing for

 self hosted users. Main goals of the project are to be simple to

 setup, secure and have support for ARM devices.

Screenshots:

- [[https://raw.githubusercontent.com/ap4y/cloud/master/screenshot2.png][Gallery Grid]]

- [[https://raw.githubusercontent.com/ap4y/cloud/master/screenshot1.png][Gallery Preview]]

- [[https://raw.githubusercontent.com/ap4y/cloud/master/screenshot3.png][Files Preview]]

- [[https://raw.githubusercontent.com/ap4y/cloud/master/screenshot4.png][Files Grid]]

** Getting started

*Cloud* is a [[https://golang.org/][golang]] application and you are going to need golang

toolchain to compile the app.

To install or update run:

#+BEGIN_SRC shell

go get -u github.com/ap4y/cloud/cmd/cloud

#+END_SRC

Web UI is implemented using [[https://reactjs.org/][react]] and is pre-bundled into golang

app. To setup local development environment for react app you will

need [[https://nodejs.org][node.js]] with either ~npm~ or ~yarn~. 

To pull react app dependecies run:

#+BEGIN_SRC shell

cd app

npm install

#+END_SRC

To start local development setup:

#+BEGIN_SRC shell

cd app

npm start

#+END_SRC

This will start ~creat-react~ web server on a port ~3000~, you can proxy

local ~cloud~ app to it using ~-devURL~ argument.

** Configuration

*Cloud* uses ~json~ config files to setup authentication and necessary paths. [[https://github.com/ap4y/cloud/blob/master/config.example.json][Sample config]]:

#+BEGIN_SRC js

{

  "jwt_secret": "secret",

  "modules": ["gallery"],

  "users": {

    "ap4y": "$2b$10$fEWhY87kzeaV3hUEB6phTuyWjpv73V5m.YcqTxHXnvqEGIou1tXGO"

  },

  "share": {

    "path": "./"

  },

  "gallery": {

    "path": "/mnt/media/Photos/Export/",

    "cache": "/tmp/cloud/"

  },

  "files": {

    "path": "/mnt/media/Photos/Export/"

  }

}

#+END_SRC

Configuration fields:

- ~jwt_secret~ is a secret used for [[https://jwt.io/][JWT]] (~HS256~ algorithm) related operations.

- ~modules~ defines enabled modules.

- ~users~ defines ~bcrypt~ hashes for user credentials, you can use

  ~mkpasswd~ to hash your passwords.

- ~share~ setups a share storage. ~path~ defines storage location for

  a disk share storage.

- ~gallery~ defines necessary paths for the gallery module. ~path~ is

  a gallery source folder and ~cache~ is a thumbnail cache folder.

- ~files~ defines necessary paths for the files module. ~path~ is

  a source folder for this module.

Additionally following command line arguments are supported:

- ~-config cloud.json~ - path to a config file.

- ~-addr :8080~ - address to listen on.

- ~-devURL~ - enables proxy mode for a local react development server.

** Gallery

Gallery provides common image gallery features: image grid, thumbnails

and full screen previews. Gallery traverses provided ~path~ on a disk

and exposes folders with images as shareable galleries. Thumbnails are

generated on the fly and cached for subsequent use.

** Files

Files provides file viewer interface with a basic management

features. Files module traverses provided ~path~ on a disk and

construct a tree, parts of the tree can be individually shared.