flowinity / flowinity Goto Github PK

Flowinity (formerly PrivateUploader) is the ultimate open source image uploader and file storage solution.

License: GNU Affero General Public License v3.0

TypeScript 52.75% CSS 1.82% HTML 0.70% JavaScript 0.97% Vue 43.32% SCSS 0.39% Shell 0.01% Dockerfile 0.01% EJS 0.03%

chat cloud-server cloud-storage cloud-suite docker file private privateuploader self-hosted server sharenix sharex sharex-server sharex-uploader suite typescript upload uploader vue vuetify

flowinity's Introduction

Flowinity (formerly PrivateUploader)

Flowinity is the next generation image hosting server written in Vue and TypeScript.

Flowinity is intended to be an out of the way image hosting server for everyone else, thus it doesn't have features you'd regularly find in other ShareX servers, such as rich OpenGraph embeds. But instead has unique features like Insights, and Collections.

Additionally, Flowinity has only recently become an open source project, so documentation and resources are lacking initially, but will improve over time.

Don't want to host your own server?

You can use the official public instance of Flowinity at https://flowinity.com (previously https://privateuploader.com).

Screenshots (Click to expand)

View the full collection on Flowinity.

Features

Gallery, where all your uploaded files live.
Collections, which can be shared with multiple users.
AutoCollects, create custom rules to automatically add items into collections.
Workspaces, create quick notes/documents inside Flowinity.
Insights, see reports about how, and when you use Flowinity.
Communications, the built-in messaging platform to communicate with other users.
Scoped API keys for additional security.
Scoped passwords, set custom passwords with different API permissions.
ShareX, and Sharenix support (built-in client export).

System Requirements

Node.js 18.0.0 or newer (NodeJS 18 is necessary for structuredClone, no polyfills are built-in)
2GB of RAM or more (RAM usage is dependent on the number of threads Flowinity uses)
4GB of disk space or more (for core server, database, and frontend files)
64-bit x86 or ARM processor, 1 CPU core or more (4 recommended)
MariaDB server (MySQL won't work, Sequelize dialect "mysql" does not support JSON)
Redis server with RedisJSON plugin (only works with UNIX-like systems)
Linux, other UNIX-based like macOS (Microsoft Windows is not officially supported)
Tesseract OCR (with English language support) for OCR features

Setting Up

These instructions assume you're using a standard Linux system with systemd, these instructions will differ depending on what init system you use.

Docker w/ docker-compose (Quickest method)

Clone the Docker-specific repo: git clone https://github.com/PrivateUploader/docker-compose flowinity
Change directory into repo: cd flowinity
Create the container (change the environment variables to your liking): DB_DATABASE=flowinity DB_USER=flowinity DB_PASSWORD=CHANGE_ME DB_ROOT_PASSWORD=CHANGE_ME docker-compose up -d
Follow the setup wizard on http://localhost:34582
You must change the MariaDB server hostname to mariadb and the redis hostname to redis in the setup wizard. (seen below):

Manual Setup

Create Flowinity user and group: useradd -m flowinity
Install MariaDB and Redis (with the RedisJSON plugin) on your server.
Login as the Flowinity user: su flowinity
Change directory into TPU home directory: cd
Clone the repository: git clone https://github.com/PrivateUploader/Flowinity flowinity
Change directory into the repository: cd flowinity
Install dependencies: yarn install
Create systemd service files for TPU with cp flowinity.service /etc/systemd/system/flowinity.service
Modify the systemd service file (use nano, vim, etc), replace all instances of CHANGE_ME with your own values. Do not run Flowinity as root user and use the user created earlier.
Start TPU and start on boot with systemctl enable flowinity --now
Follow the setup wizard on http://localhost:34582 and configure NGINX web server.

NGINX Configuration

TPU includes an example NGINX configuration file, you can find it at nginx.conf in either of the Docker or primary TPU repositories.
Copy it to your NGINX configuration directory: cp nginx.conf /etc/nginx/conf.d/flowinity.conf (this folder can differ between distributions, it could be /etc/nginx/sites-available, if so, symlink it to /etc/nginx/sites-enabled).
Modify the NGINX configuration file (use nano, vim, etc), replace all instances of CHANGE_ME with your own values.
Test the NGINX configuration: nginx -t
If the test is successful, reload NGINX: nginx -s reload

Scripts

yarn build - Build Flowinity.
yarn serve - Start Flowinity in development mode.
yarn serve-cluster - Start Flowinity in development cluster mode.
yarn start - Start Flowinity in production mode and build (cluster mode).

Even if you only have 1 CPU core/thread, you should still use start in production as it will support the TPU_RESTART process command and will automatically scale if you add more CPU cores/threads.

Do not restart Flowinity via `pm2` or `systemd` if you are using the `serve-cluster` script in production.

This can be done in the admin panel or via a POST request to /api/v3/admin/restart (administrator account required, can be automated with "admin.ci" API scope).

Having a single CPU core will cause Flowinity to be temporarily unavailable when restarting.

Contributors

_Troplo
💻 📖 🔣 🚇 🛡️

_{The Loose Goose}
💻 🚇 🌍

_bytedefined
💻 🌍 🤔 🐛

_ElectricS01
💻 🤔 🐛

_Jolt707
💻 🤔 🐛 ️️️️♿️

flowinity's People

Contributors

Stargazers

Watchers

Forkers

electrics01 theloosegoose flowinity spysder colouredflower furkan3d flowinity diplesbtw fossabot

flowinity's Issues

Nothing showing up after initial frontend build

Hey! Just found this project and wanted to test it out, currently using the docker instructions, on initial start it comes up with the whole frontend being built page and then after I waited a few minutes and checked logs to make sure the frontend was built, going back to https://url/setup brings just a blank page.

Logs from browser console:

Logs from main tpu docker container:

Logs from redis docker container:

Logs from mariadb docker container:

Let me know if there's anything else you need!

Toggle to hide weather icon

It would be really great if there was a toggle that disabled showing the weather icon in the navigation header of TPU

Add existing contributors

@all-contributors
please add @Troplo for code doc data infra security.
please add @theloosegoose for code infra.
please add @Bytedefined for code translation ideas bug.
please add @ElectricS01 code ideas bug.
please add @Jolt707 code ideas bug a11y.

Backend unit tests using `yarn test` don't work

Executing yarn test results in database related error messages

$ NODE_ENV=test yarn init:db && yarn test:no-db
$ NODE_ENV=test ts-node ./app/testStart.ts
Suppressed 1 Redis error as Flowinity Server is not yet configured.
init
(node:17765) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
(Use `node --trace-deprecation ...` to show where the warning was created)
Redis Client Connected
~/GitHub/PrivateUploader/node_modules/sequelize/src/dialects/mariadb/connection-manager.js:109
          throw new SequelizeErrors.HostNotFoundError(err);
                ^
HostNotFoundError [SequelizeHostNotFoundError]: getaddrinfo ENOTFOUND host
    at ConnectionManager.connect (~/GitHub/PrivateUploader/node_modules/sequelize/src/dialects/mariadb/connection-manager.js:109:17)
    at processTicksAndRejections (node:internal/process/task_queues:95:5)
    at async ConnectionManager._connect (~/GitHub/PrivateUploader/node_modules/sequelize/src/dialects/abstract/connection-manager.js:332:24)
    at async ~/GitHub/PrivateUploader/node_modules/sequelize/src/dialects/abstract/connection-manager.js:250:32
    at async ConnectionManager.getConnection (~/GitHub/PrivateUploader/node_modules/sequelize/src/dialects/abstract/connection-manager.js:280:7)
    at async ~/GitHub/PrivateUploader/node_modules/sequelize/src/sequelize.js:638:26
    at async init (~/GitHub/PrivateUploader/app/testStart.ts:23:3) {
  parent: Error: getaddrinfo ENOTFOUND host
      at GetAddrInfoReqWrap.onlookupall [as oncomplete] (node:dns:118:26)
   From event:
      at ~/GitHub/PrivateUploader/node_modules/mariadb/lib/connection.js:141:13
      at new Promise (<anonymous>)
      at Connection.connect (~/GitHub/PrivateUploader/node_modules/mariadb/lib/connection.js:130:12)
      at Object.createConnection (~/GitHub/PrivateUploader/node_modules/mariadb/promise.js:38:17)
      at ConnectionManager.connect (~/GitHub/PrivateUploader/node_modules/sequelize/src/dialects/mariadb/connection-manager.js:87:41)
      at ConnectionManager._connect (~/GitHub/PrivateUploader/node_modules/sequelize/src/dialects/abstract/connection-manager.js:332:61)
      at processTicksAndRejections (node:internal/process/task_queues:95:5)
      at async ~/GitHub/PrivateUploader/node_modules/sequelize/src/dialects/abstract/connection-manager.js:250:32
      at async ConnectionManager.getConnection (~/GitHub/PrivateUploader/node_modules/sequelize/src/dialects/abstract/connection-manager.js:280:7)
      at async ~/GitHub/PrivateUploader/node_modules/sequelize/src/sequelize.js:638:26 {
    errno: -3008,
    code: 'ENOTFOUND',
    syscall: 'getaddrinfo',
    hostname: 'host',
    fatal: true,
    sqlState: 'HY000'
  },
  original: Error: getaddrinfo ENOTFOUND host
      at GetAddrInfoReqWrap.onlookupall [as oncomplete] (node:dns:118:26)
   From event:
      at ~/GitHub/PrivateUploader/node_modules/mariadb/lib/connection.js:141:13
      at new Promise (<anonymous>)
      at Connection.connect (~/GitHub/PrivateUploader/node_modules/mariadb/lib/connection.js:130:12)
      at Object.createConnection (~/GitHub/PrivateUploader/node_modules/mariadb/promise.js:38:17)
      at ConnectionManager.connect (~/GitHub/PrivateUploader/node_modules/sequelize/src/dialects/mariadb/connection-manager.js:87:41)
      at ConnectionManager._connect (~/GitHub/PrivateUploader/node_modules/sequelize/src/dialects/abstract/connection-manager.js:332:61)
      at processTicksAndRejections (node:internal/process/task_queues:95:5)
      at async ~/GitHub/PrivateUploader/node_modules/sequelize/src/dialects/abstract/connection-manager.js:250:32
      at async ConnectionManager.getConnection (~/GitHub/PrivateUploader/node_modules/sequelize/src/dialects/abstract/connection-manager.js:280:7)
      at async ~/GitHub/PrivateUploader/node_modules/sequelize/src/sequelize.js:638:26 {
    errno: -3008,
    code: 'ENOTFOUND',
    syscall: 'getaddrinfo',
    hostname: 'host',
    fatal: true,
    sqlState: 'HY000'
  }
}
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.