]> git.ipfire.org Git - ipfire.org.git/commitdiff
location: Explain more basic information
authorMichael Tremer <michael.tremer@ipfire.org>
Wed, 3 Apr 2024 14:46:36 +0000 (14:46 +0000)
committerMichael Tremer <michael.tremer@ipfire.org>
Wed, 3 Apr 2024 14:46:36 +0000 (14:46 +0000)
Signed-off-by: Michael Tremer <michael.tremer@ipfire.org>
src/templates/location/how-to-use/index.html

index 1448d50c77e86940412c77ab484b2aed535527a1..df3e1c4ed3e38f892e9825e10f9e34cb9dfca625 100644 (file)
                                </nav>
 
                                <h1 class="title">{{ _("How To Use?") }}</h1>
-                       </div>
-               </div>
-       </section>
 
-       <section class="section">
-               <div class="container">
-                       <p>
-                               The heart of the IPFire Location project is a small, lightweight library
-                               called <code>libloc</code>.
+                               <div class="block">
+                                       <p class="is-size-5">
+                                               IPFire Location consists of two integral components:
+                                               <code>libloc</code>, the implementation responsible for processing
+                                               geolocation data, and the actual database file containing the
+                                               comprehensive repository of IP address locations.
+                                       </p>
+                               </div>
 
-                               It sources the data, builds and reads the database.
-                       </p>
+                               <div class="block">
+                                       <p class="is-size-5">
+                                               IPFire Location offers versatile usage options tailored to diverse
+                                               needs and preferences as there are so many possible applications.
+                                               Below is a list with all available options to choose which is
+                                               is best suited for your individual organization.
+                                       </p>
+                               </div>
+                       </div>
                </div>
        </section>
 
                        </div>
                </div>
        </section>
+
+       <section class="section">
+               <div class="container">
+                       <h4 class="title is-4">{{ _("The IPFire Location Database") }}</h4>
+
+                       <div class="content">
+                               <p>
+                                       For this project, we have created a new and unique database format.
+                                       Only this way, it was possible to achieve our goals that we have laid for ourselves.
+                               </p>
+                       </div>
+
+                       <div class="block">
+                               <p class="title is-5">
+                                       Updated Daily
+                               </p>
+
+                               <div class="content">
+                                       <p>
+                                               The IPFire Location database undergoes daily refreshes to
+                                               ensure that it remains up-to-date and accurate.
+                                       </p>
+                               </div>
+                       </div>
+
+                       <div class="block">
+                               <p class="title is-5">
+                                       Small Downloads
+                               </p>
+
+                               <div class="content">
+                                       <p>
+                                               The database is very small for the amount of information it stores
+                                               allowing frequent updates without using a lot of bandwidth and disk space.
+                                               A smart download mechanism ensures that the database is only being
+                                               downloaded when needed allowing IPFire Location to be deployed in
+                                               IoT scenarios where bandwidth is scarse.
+                                       </p>
+
+                                       </p>
+                                               Other formats like CSV are many hundred megabytes in size
+                                               when the IPFire Location database only needs a few megabytes.
+                                       </p>
+                               </div>
+                       </div>
+
+                       <div class="block">
+                               <p class="title is-5">
+                                       Intelligent Storage
+                               </p>
+
+                               <div class="content">
+                                       <p>
+                                               All data is stored using optimal data structures for compression
+                                               and lookup speed.
+                                               Using binary trees and binary searches, there is no way to access
+                                               the data any faster.
+                                       </p>
+
+                                       <p>
+                                               Anything that is being stored in the database can be accessed
+                                               in nanoseconds allowing IPFire Location to be used where thousands
+                                               of lookups a second are needed.
+                                       </p>
+                               </div>
+                       </div>
+
+                       <div class="block">
+                               <p class="title is-5">
+                                       Cryptographically Signed
+                               </p>
+
+                               <div class="content">
+                                       <p>
+                                               Because IPFire Location is cryptographically signed, its authenticity
+                                               can be verified when being downloaded. Since it is being deployed in
+                                               security applications a maliciously crafted database could large damage.
+                                       </p>
+                               </div>
+                       </div>
+               </div>
+       </section>
 {% end block %}