Skip to content

Commit

Permalink
Added self-hosting section
Browse files Browse the repository at this point in the history
  • Loading branch information
DavidLazarescu authored Dec 28, 2023
1 parent 1d784e0 commit 54e77b4
Showing 1 changed file with 22 additions and 15 deletions.
37 changes: 22 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Librum is an application designed to make reading <b>enjoyable</b> and <b>straightforward</b> for everyone.

It's not **just** an e-book reader. With Librum, you can manage your own online library and access it from any device anytime, anywhere. It has features like note-taking, bookmarking, and highlighting, while offering customization to make it as personal as you want!
It's not **just** an e-book reader. With Librum, you can manage your own online library and access it from any device anytime, anywhere. It has features like note-taking, AI tooling, and highlighting, while offering customization to make it as personal as you want!

Librum also provides free access to over 70,000 books and personal reading statistics while being free and completely open source.

Expand All @@ -28,14 +28,25 @@ Customize Librum to make it personal to you

<br>

# How can I get Librum?
# Where can I get Librum?

Simply go to https://librumreader.com to download Librum.

If you want to build Librum from source, follow the instructions [here](#build-guide).

<br>

# Donations

Donations make it possible for us to cover our server costs and allow us to make investments into new areas of development.
<br>
If you would like to support us, check out: https://librumreader.com/contribute/donate or become a Github sponsor!
<br>
<br>
As a team of opensource developers we rely on donations to continue working on projects like Librum. Your help is greatly appreciated.

<br>

# Translations

Librum is currently available in:
Expand All @@ -59,7 +70,6 @@ If you run into any problems, need guidance or have questions, feel free to reac
Notes:
- Make sure that your translations are approximately the same length as the original text
- Make sure that you keep to the punctuation and capitalisation
- Make sure that your translations make sense in the context they are in

<br>

Expand All @@ -69,17 +79,6 @@ For documentation go to [Librum's GitHub-wiki](https://github.com/Librum-Reader/

<br>

# Donations

Donations make it possible for us to cover our server costs and allow us to make investments into new areas of development.
<br>
If you would like to support us, check out: https://librumreader.com/contribute/donate or become a github sponsor!
<br>
<br>
As a team of opensource developers we rely on donations to continue working on projects like Librum. Your help is greatly appreciated.

<br>

# Contributing

If you'd like to contribute, check out: https://librumreader.com/contribute
Expand All @@ -97,13 +96,21 @@ Please make sure to run clang format, keep to the conventions used throughout th

# Contact


For questions, you can reach us under: [email protected]
<br>
For business related contact, reach out to us here: [email protected]

<br>

# Self-hosting
To self-host Librum you need to run [Librum-Server](https://github.com/Librum-Reader/Librum-Server) locally (instructions can be found [here](https://github.com/Librum-Reader/Librum-Server#self-hosting)) and tell the client to use your self-hosted server by:
- (Linux) Editing ~/.config/Librum-Reader/Librum.conf and setting `selfHosted=true` and `serverHost` to your server's url (e.g. `serverHost=https://127.0.0.1:5001`)
- (Windows) Opening the registry editor (Press `Win + R` and search for `regedit`), navigating to `HKEY_CURRENT_USER\Software\Librum-Reader\Librum` and setting `selfHosted=true` and `serverHost` to your server's url

Make sure to run the application before following the steps above, to generate the required files.

<br>

# Details

### Supported platforms
Expand Down

0 comments on commit 54e77b4

Please sign in to comment.