Go to file
2017-05-12 22:37:22 +02:00
env Remove all user specific data into the config 2017-05-11 21:37:39 +02:00
resources Remove all user specific data into the config 2017-05-11 21:37:39 +02:00
src Make a release :) 2017-05-12 22:37:22 +02:00
.gitignore Add stuff to .gitignore 2017-03-28 12:42:54 +02:00
deploy.sh Make a release :) 2017-05-12 22:37:22 +02:00
docker-compose.yml Make a release :) 2017-05-12 22:37:22 +02:00
Dockerfile Make a release :) 2017-05-12 22:37:22 +02:00
Procfile Time to start over 2017-02-16 22:31:16 +01:00
project.clj Add timezone, image description, code cleanup, ... #18 2017-04-18 23:14:16 +02:00
README Make a release :) 2017-05-12 22:37:22 +02:00
yenu.properties Remove all user specific data into the config 2017-05-11 21:37:39 +02:00



               oooo    ooo  .ooooo.  ooo. .oo.   oooo  oooo 
                `88.  .8'  d88' `88b `888P"Y88b  `888  `888 
                 `88..8'   888ooo888  888   888   888   888 
                  `888'    888    .o  888   888   888   888 
                   .8'     `Y8bod8P' o888o o888o  `V88V"V8P'
               .o..P'                                       
               `Y8P'              the image sharing tool for friends. 


  yenu is a simple tool to share images among a trusted group of people. No
  complicated setup, no fancy features nobody really uses, no role management,
  no cloud, no bullshit. Just sharing images to people you like and store
  your data where you want it to be.

--{ INSTALL }------------------------------------------------------------------
  Create the database schema and all needed folders. You need to execute
  this only once for initial setup. IF you upgrade the yenu version (replace
  the yenu.jar file), it is sometimes needed to run the migrate step again.
  
  $ java -jar yenu.jar migrate

  Start the application with the following command in a screen session or
  write a systemd init file for that.
  $ java -jar yenu.jar

  If you like docker, you can use docker-compose to boot up the application
  and send it to the background.
  $ docker-compose up -d


--{ CONFIGURATION }------------------------------------------------------------
  The application is configured with the yenu.properties file. Open the file
  in your preferred editor and change the variables as you like. You can change
  the basepath, port and other stuff like the user password and the creator
  password.
  

--{ WHERE IS MY DATA? }--------------------------------------------------------
  All your images are placed in the data/gallery/ directory, next to the
  yenu.jar. When uploading a image, the raw file is placed into the raw/ folder,
  if you need the original later (pull out some metadata like GPS coordinates,
  scale it into other formats, print it etc.) In the normal/ folder there are
  the scaled down images for the details page. The thumbnails/ folder contains
  the quare images for the thumbnail preview.

  The database used is a SQLite3 database, stored in the yenu.db file. You
  can open the database at any time with your favourite sqlite3 client.

  $ sqlite3 yenu.db
  > .tables
  > SELECT * FROM images;
  > ...
  

--{ WHERE CAN IS RUN THIS THING? }---------------------------------------------
  Quick answer: Wherever you want. You can boot up a Amazon S3 node and deploy
  it there or you put it on your RaspberryPi and host it yourself from your
  own internet connection from home (preferred way!). You can also rent a
  vServer and deploy it there. All you need is a Java RE and a internet
  connection.
  

--{ LICENSE, RIGHTS AND AUTHOR }-----------------------------------------------
  This tool is written by Aaron Fischer (aaron-fischer.net). It is free to use
  and is placed under the GPL v.3. The images, comments and other metadata
  belongs to you. Make sure, you store the data on a place you trust and make
  backups.