elixire logo

elixire

  •  0 ratings
In category: File Transfer / Single-click & Drag-n-drop Upload

About elixire

Simple yet advanced screenshot uploading and link shortening service.

  •   319  
  •   0  
  •   0  
  •   0  
Github stats:
  •  Commits: 1,726  
  •   25  
  •   16  
  •  Latest commit: N/A  

Deploy this app to Linode with a free $100 credit!

Languages/Platforms/Technologies:
Lincenses:

More about elixire

Elixire

"elixirae is the futureae"
  - lunae bunae genserv, 2018

Elixire is an open source image host solution.

The first iteration of Elixire was written in PHP, then rewritten in Python and this is the main language we are working on.

(no, we won't write Elixir, read BACKEND.md for the reason)

Installation and Running

Dockerfiles exist in this repository. Do not attempt to run them. (Merge Requests "fixing" them will be closed.)

Requirements:

  • Python 3.7+ (3.8 recommended)
  • PostgreSQL
  • Redis
  • A decent version of Node

Optional requirements:

  • ClamAV, for virus scanning of uploads.
  • InfluxDB, for metrics (look into docs/MANAGE.md for more detail).
  • Mailgun, so that the instance becomes able to send emails to users.
  • Discord webhooks (so that the admins know when a malicious file was uploaded, etc).
git clone https://gitlab.com/elixire/elixire.git
cd elixire

# Download the current versions for frontend and admin-panel.
git submodule init
git submodule update

# You are able to use a virtual enviroment if you want.
python3.7 -m pip install -Ur requirements.txt

# Please edit schema.sql before continuing.
# Specially the "INSERT INTO domains" line.
psql -U postgres -f schema.sql

# Read carefully over the configuration file
# to enable/disable instance features (like registration and webhooks).
cp config.py.example config.py

# Edit frontend/config.json and admin-panel/config.json
# so they're pointing to your domain.

# Update frontend and admin-panel repositories.
# Use this makefile task to update your instance.
make update

# Build the frontend and the admin-panel.
make

# Run application, also works under external process managers.
hypercorn run.py --access-log - --bind 0.0.0.0:8081

Operator's Manual

TODO

Here's some important notes while this is still a todo:

  • If you're reverse proxying the instance (you should), enable Host header forwarding in your reverse proxy (such as proxy_set_header Host $host; in nginx).
  • If you get an error saying something like "route already registered", then you forgot to build the frontend, either disable it or build the frontend. You need a reasonably decent node version.
  • Ensure that you redirect www to non-www or non-www to www or else the domain checking stuff won't be super happy (you'll not be able to fetch stuff properly).

Tools

Please look under the docs/ directory for more complete tooling documentation.

API Documentation

See this repo for API Docs. Both the Client API and the Admin API are documented there.

Setting and running a test environment

NOTE: It is not recommended to run the test suite in production environments, as it will run against the currently configured database.

Install tox globally, as that will take care of creating a dedicated virtual environment for testing:

python3 -m pip install tox

Then, run it.

tox

Comments (0)

Please login to join the discussion on this project.

elixire Reviews (0)

Overall Rating

None

based on 0 ratings

Please login to review this project.

No reviews for this project yet.

↑ back to top

pCloud Lifetime

Popular Projects

FluxBB

in Social Networks and Forums
 33k    0    0    0  

Nextcloud

in File Transfer & Synchronization
 21k    1    1    0  

Libreddit

in Social Networks and Forums
 7k    0    1    0  

Dashboard

in Personal Dashboards
 6k    0    0    0  

Audiobookshelf

in Audio Streaming
 6k    0    1    0  

CasaOS

in Self-hosting Solutions
 5k    0    0    0  

Mediagoblin

in Photo and Video Galleries
 4k    0    0    0  

Most Discussed

Nextcloud

in File Transfer & Synchronization
 21k    1    1    0  

Tube Archivist

in Automation
 3k    0    1    0  

OneDev

in Project Management
 2k    0    0    0  

iodine

in Proxy
 2k    0    0    0  

Alf.io

in Booking and Scheduling
 2k    0    0    0  

sysPass

in Password Managers
 1k    0    0    0  

Misskey

in Social Networks and Forums
 2k    0    0    0  
Linux VPS from $11/yr.
RackNerd VPS for $11.38/mo

Top Rated Projects

Gitea

 1 rating
in Project Management

Bagisto

 1 rating
in E-commerce

LinkAce

 1 rating
in Bookmarks and Link Sharing

Pydio

 1 rating
in File Transfer & Synchronization

Audiobookshelf

 1 rating
in Audio Streaming

Nextcloud

 1 rating
in File Transfer & Synchronization

Seafile

 1 rating
in File Transfer & Synchronization

Categories

You May Also Be Interested In

Plik logo
Plik cover

Plik

Plik is a scalable and friendly temporary file upload syste…

Uploady logo
Uploady cover

Uploady

Uploady is a simple file uploader script with multi file up…

ass logo
ass cover

ass

The superior self-hosted ShareX server. For use with client…