Calibre: Difference between revisions

From wikinotes
 
(11 intermediate revisions by the same user not shown)
Line 1: Line 1:
Calibre is a digital library management software tool.
Calibre is an ebook management tool and RSS reader.
 
{{ WARNING |
Calibre is not a multi-user program. It is also not designed to share a library on a network drive.
 
The official recommendation is to use a content-server.
 
workarounds:
http://james.jamesandkristin.net/2012/04/22/accessing-your-ebook-collection-managed-by-calibre-without-calibre-server
}}


= Documentation =
= Documentation =
Line 25: Line 16:
{| class="wikitable"
{| class="wikitable"
|-
|-
| <code>8080</code> || port
| <code>8080</code> || default port
|-
|-
| <code>${CALIBRE_URL}/mobile</code> || javascript-free version
| <code>${CALIBRE_URL}/mobile</code> || javascript-free version
|-
|-
| <code>/home/calibre/.config/calibre/server-users.sqlite</code> || calibre server user database
| <code>${CALIBRE_USER_HOME}/.config/calibre/server-users.sqlite</code> || calibre server user database
|-
|-
|}
|}
Line 41: Line 32:
| [[calibre install]]
| [[calibre install]]
|-
|-
!colspan=1| Server
!colspan=1| Server (Web UI)
|-
|-
| [[calibre server usage]]
| [[calibre server usage]]
Line 50: Line 41:
|-
|-
| [[calibre gui usage]]
| [[calibre gui usage]]
|-
| [[calibre gui configuration]]
|-
|}
|}
</blockquote><!-- Notes -->
</blockquote><!-- Notes -->


= Usage =
= Extensions =
<blockquote>
<blockquote>
Calibre is designed as a single-user application, '''but''' it's web-server is designed to host a variable number of users.
{|
|-
| [[calibre-web]] || alternative web-UI
|-
| [[calibre-opds-client]] || access books from calibre-server over OPDS, download to local calibre
|-
|}
</blockquote><!-- Extensions -->


== server ==
= Clients =
 
<blockquote>
{{ TODO |
== Linux ==
Add --enable-auth after adding a user to calibre-server, and you can add books using the web-interface.
<blockquote>
{| class="wikitable"
|-
| [[thorium]] || linux OPDS reader, library
|-
| [[foliate]] || linux OPDS reader, library
|-
|}
</blockquote><!-- Linux -->


https://manual.calibre-ebook.com/server.html#managing-user-accounts-from-the-command-line-only
== IOS ==
}}
 
<source lang="bash">
sudo -u calibre calibre-server --manage-users  # create/edit users (execute when calibre-server started w/o --enable-auth)
</source>
 
<source lang="bash">
# Adding books from commandline
https://manual.calibre-ebook.com/generated/en/calibredb.html#add
 
calibredb \
  --library-path /mnt/smbshares/books/textbooks \
  --password <pass> \
  --username <user> \
  add \
  --authors "Smith John" \
  --tags "ComputerProgramming: Python, ComputerProgramming: Methodologies" \
  --title "Your Book"
</source>
 
== gui ==
<source lang="bash">
calibre --with-library=/mnt/book/textbooks                # run calibre with a library in a specific location
 
Calibre > Calibre Library > Choose your calibre Library    # open a different library
</source>
</blockquote><!-- Usage -->
 
= Configuration =
<blockquote>
<blockquote>
{{ WARNING |
{| class="wikitable"
Calibre now explicitly disallows sharing a library over a network share. I have been adding books by means of the web interface.
|-
}}
| [[kybook3]] || ios OPDS reader, library
If reading a calibre library off a samba-share, you must mount as CIFS with the option: nobrl, otherwise your
|-
database will appear corrupt due to locking.
| [[marvin3]] || ios OPDS reader, library
 
|-
<source lang="ini">
|}
//192.168.1.220/books            /mnt/books          cifs    auto,_netdev,users,nobrl,dir_mode=0777,file_mode=0664,gid=smbshare,x-systemd.automount 0 0
</blockquote><!-- IOS -->
 
</blockquote><!-- Clients -->
</source>
 
{{ NOTE |
This works fine to read, but fails when trying to add books to the library.<br>
 
Try setting environment variable $CALIBRE_OVERRIDE_DATABASE_PATH to read books off the
network, but keep your own local database for them.<br>
 
See https://manual.calibre-ebook.com/customize.html
}}
</blockquote><!-- configuration -->

Latest revision as of 06:59, 26 November 2022

Calibre is an ebook management tool and RSS reader.

Documentation

user manual https://manual.calibre-ebook.com/
server manual https://manual.calibre-ebook.com/generated/en/calibre-server.html

Locations

8080 default port
${CALIBRE_URL}/mobile javascript-free version
${CALIBRE_USER_HOME}/.config/calibre/server-users.sqlite calibre server user database

Notes

General
calibre install
Server (Web UI)
calibre server usage
calibre server configuration
GUI
calibre gui usage
calibre gui configuration

Extensions

calibre-web alternative web-UI
calibre-opds-client access books from calibre-server over OPDS, download to local calibre

Clients

Linux

thorium linux OPDS reader, library
foliate linux OPDS reader, library

IOS

kybook3 ios OPDS reader, library
marvin3 ios OPDS reader, library
Retrieved from "http://willpittman.net:8080/index.php?title=Calibre&oldid=32265"