matthew/BrickTracker
1
0
Fork 0
forked from FrederikBaerentsen/BrickTracker
Code Pull Requests Activity

Remove <br> from blockquotes to accomodate Gitea markdown processing

Browse Source
This commit is contained in:
Gregoo 2025-01-24 10:51:14 +01:00
parent 42e42b9a1b
commit 913ceb339e
8 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/authentication.md
View File

@ -1,9 +1,9 @@
# Authentication # Authentication
> **Note**<br> > **Note**
> The following page is based on version `1.0.0` of BrickTracker. > The following page is based on version `1.0.0` of BrickTracker.
> **Warning**<br> > **Warning**
> This is a lightweight access control feature and does not provide any strong layer of security to the application. > This is a lightweight access control feature and does not provide any strong layer of security to the application.
By default, every feature of the application is available. By default, every feature of the application is available.
@ -15,7 +15,7 @@ To set up the authentication, you need to set the two following environment vari
- `BK_AUTHENTICATION_KEY`: a secret for the server to encrypt the session cookie. See [.env.sample](../.env.sample) for how to generate the value - `BK_AUTHENTICATION_KEY`: a secret for the server to encrypt the session cookie. See [.env.sample](../.env.sample) for how to generate the value
- `BK_AUTHENTICATION_PASSWORD`: the actual password - `BK_AUTHENTICATION_PASSWORD`: the actual password
> **Warning**<br> > **Warning**
> The password is stored in **plaintext**. Be mindful. > The password is stored in **plaintext**. Be mindful.
Once the authentication is set up, you should see a ![read-only](images/authentication-01.png) pill on the right side of the menu bar. Once the authentication is set up, you should see a ![read-only](images/authentication-01.png) pill on the right side of the menu bar.

14
docs/bricktracker.md
View File

@ -1,6 +1,6 @@
# BrickTracker # BrickTracker
> **Note**<br> > **Note**
> The following page is based on version `1.0.0` of BrickTracker. > The following page is based on version `1.0.0` of BrickTracker.
## Frontpage ## Frontpage
@ -14,7 +14,7 @@ You can click the card name or image to access a set or minifigure detail.
## Sets ## Sets
> **Info**<br> > **Info**
> This does not do any pagination and loads **everything**. It can be slow depending on how many sets you have. > This does not do any pagination and loads **everything**. It can be slow depending on how many sets you have.
![](images/bricktracker-02.png) ![](images/bricktracker-02.png)
@ -66,7 +66,7 @@ If an error occur, it will put back in the input field the list of number that w
## Parts ## Parts
> **Info**<br> > **Info**
> This does not do any pagination and loads **everything**. It can be slow depending on how many sets you have. > This does not do any pagination and loads **everything**. It can be slow depending on how many sets you have.
![](images/bricktracker-06.png) ![](images/bricktracker-06.png)
@ -79,7 +79,7 @@ Clicking on a part name will load its details.
## Missing (parts) ## Missing (parts)
> **Info**<br> > **Info**
> This does not do any pagination and loads **everything**. It can be slow depending on how missing parts you have. > This does not do any pagination and loads **everything**. It can be slow depending on how missing parts you have.
![](images/bricktracker-07.png) ![](images/bricktracker-07.png)
@ -92,7 +92,7 @@ Clicking on a part name will load its details.
## Minifigures ## Minifigures
> **Info**<br> > **Info**
> This does not do any pagination and loads **everything**. It can be slow depending on how many minifigures you have. > This does not do any pagination and loads **everything**. It can be slow depending on how many minifigures you have.
![](images/bricktracker-08.png) ![](images/bricktracker-08.png)
@ -105,7 +105,7 @@ Clicking on a minifigure name will load its details.
## Instructions ## Instructions
> **Info**<br> > **Info**
> This does not do any pagination and loads **everything**. It can be slow depending on how many instructions you have. > This does not do any pagination and loads **everything**. It can be slow depending on how many instructions you have.
![](images/bricktracker-08.png) ![](images/bricktracker-08.png)
@ -118,7 +118,7 @@ Clicking on a set image will open it fullscreen.
## Wishlist ## Wishlist
> **Info**<br> > **Info**
> This does not do any pagination and loads **everything**. It can be slow depending on how many wished sets you have. > This does not do any pagination and loads **everything**. It can be slow depending on how many wished sets you have.
![](images/bricktracker-12.png) ![](images/bricktracker-12.png)

4
docs/common-errors.md
View File

@ -1,6 +1,6 @@
# Common errors/problems # Common errors/problems
> **Note**<br> > **Note**
> The following page is based on version `1.0.0` of BrickTracker. > The following page is based on version `1.0.0` of BrickTracker.
## I need a password to access some pages ## I need a password to access some pages
@ -36,7 +36,7 @@ services:
env_file: ".env" env_file: ".env"
``` ```
> **Warning**<br> > **Warning**
> Do not use quotes (", ') around your environment variables. > Do not use quotes (", ') around your environment variables.
> Docker will interpret them has being part of the **value** of the environment variable. > Docker will interpret them has being part of the **value** of the environment variable.
> For instance... > For instance...

2
docs/development.md
View File

@ -1,6 +1,6 @@
# Development # Development
> **Note**<br> > **Note**
> The following page is based on version `1.0.0` of BrickTracker. > The following page is based on version `1.0.0` of BrickTracker.
The application is written in Python version 3. The application is written in Python version 3.

8
docs/first-steps.md
View File

@ -1,6 +1,6 @@
# First steps # First steps
> **Note**<br> > **Note**
> The following page is based on version `1.0.0` of BrickTracker. > The following page is based on version `1.0.0` of BrickTracker.
## Database initialization ## Database initialization
@ -35,10 +35,10 @@ If everything went well you should see no more error message and some counters.
## Add a set ## Add a set
> **Important**<br> > **Important**
> Make sure you have set up your Rebrickable API key (`BK_REBRICKABLE_KEY`) for this to work (see [common errors](common-errors.md)). > Make sure you have set up your Rebrickable API key (`BK_REBRICKABLE_KEY`) for this to work (see [common errors](common-errors.md)).
> **Important**<br> > **Important**
> If you are using the CORS allowed origin restriction (`BK_DOMAIN_NAME`), make sure it is matching your application URL (see [common errors](common-errors.md)). > If you are using the CORS allowed origin restriction (`BK_DOMAIN_NAME`), make sure it is matching your application URL (see [common errors](common-errors.md)).
Use the menu bar to navigate to the **Add** page, make sure the socket is in a **connected** state. Use the menu bar to navigate to the **Add** page, make sure the socket is in a **connected** state.
@ -55,7 +55,7 @@ It will load information about the set you are about to add, but not add it yet.
Use the **Confirm add** button to add the set, or the **Dismiss** button if it is not the one you wanted. Use the **Confirm add** button to add the set, or the **Dismiss** button if it is not the one you wanted.
> **Note**<br> > **Note**
> If you do not want to go through the confirmation process, check the **Add without confirmation** checkbox and the > If you do not want to go through the confirmation process, check the **Add without confirmation** checkbox and the
> set will be added when you press the **Add** button. > set will be added when you press the **Add** button.

4
docs/move-existing-database.md
View File

@ -2,7 +2,7 @@
If you are coming from the original version of BrickTracker and you wish to move your database from a bind mount to a volume, you can follow this procedure. If you are coming from the original version of BrickTracker and you wish to move your database from a bind mount to a volume, you can follow this procedure.
> **Note**<br> > **Note**
> If you already have a copy of your `app.db` file easily available, you can skip directly to "Move the database" section > If you already have a copy of your `app.db` file easily available, you can skip directly to "Move the database" section
## Update to version 1.0.0 ## Update to version 1.0.0
@ -57,7 +57,7 @@ This will download a copy of the database file to your computer.
Now that you have a copy of your database, you can tell the application its new path. Now that you have a copy of your database, you can tell the application its new path.
Edit the `BK_DATABASE_PATH` environment variable and redeploy your application. Edit the `BK_DATABASE_PATH` environment variable and redeploy your application.
> **Note**<br> > **Note**
> The name of the database file does not have to be `app.db` > The name of the database file does not have to be `app.db`
For instance: For instance:

2
docs/set.md
View File

@ -1,6 +1,6 @@
# Managing your sets # Managing your sets
> **Note**<br> > **Note**
> The following page is based on version `1.0.0` of BrickTracker. > The following page is based on version `1.0.0` of BrickTracker.
## Set image ## Set image

4
docs/setup.md
View File

@ -1,6 +1,6 @@
# Setup # Setup
> **Note**<br> > **Note**
> The following page is based on version `1.0.0` of BrickTracker. > The following page is based on version `1.0.0` of BrickTracker.
## Prerequisites ## Prerequisites
@ -34,7 +34,7 @@ services:
env_file: ".env" env_file: ".env"
``` ```
> **Warning**<br> > **Warning**
> Do not use quotes (", ') around your environment variables. > Do not use quotes (", ') around your environment variables.
> Docker will interpret them has being part of the **value** of the environment variable. > Docker will interpret them has being part of the **value** of the environment variable.
> For instance... > For instance...