Skip to content

User Guide

Jump to bottom
Laim edited this page Jan 31, 2026 · 1 revision

Note

This was written while development was still ongoing. There may be slight wording or design changes.

Login and Registration

Once you've installed MyFicDB and you go to the site in your browser, the first page you will see is the Login. Click Register and sign up for your account. Once this account is created, registration will be disabled as MyFicDB is designed as a single-user system.

Password Reset

If you forget your password, you can reset it by setting some variables in the docker-compose file. Shut down your container and modify docker-compose.yml and add in these values under environment:

MYFICDB_RESET_PASSWORD: true
MYFICDB_RESET_PASSWORD_VALUE: "newpasswordhere"

Start your container up again and login with the new password. If successful, shut down the container again, remove the above variables and start it up again. This ensures that

  1. You've not got your password stored in clear-text in your docker compose
  2. It doesn't reset the password every single time you start up a MyFicDB container

Two Factor Authentication

Caution

Ensure you keep a copy of your back up codes, there is currently no way to reset 2FA if you lose Authenticator access.

MyFicDB supports Two Factor Authentication. go to {url}/account/2fa to set it up.

Creating and Editing a Story

Create

To create a Story, click Stories in the navigation bar and then click Create Story on the top right. You will then be presented with the Create Story View which has a few options

  • Title [required]
  • Synopsis [required]
  • Notes [optional]
  • Tags [optional]
  • Series [optional]
  • Actors [optional]

There are also three switches at the top for tagging the work as your own, AI generated or NSFW.

Create Story View

Note

Tags and Series can only be created in the Story Create or Story Edit View. Actors can be created here or on /actors.

Tags, Series and Actors are comma seperated and has a suggestion system for existing Tags, Series and Actors in the system. To create a new T/S/A, simply type in the name and add a comma after it: dark comedy, fiction, family

Once you have your initial details for your Story, click Create at the bottom of the page. The story will be created and it will re-direct you to the Story View.

Edit

To edit a Story, click on your Story and click Edit on the top right. This view is (or should be) identical to the Story Create View.

You can add new or remove tags, series and actors here, and update the information populated during creation.

Chapters

Note

There is currently no limit on the amount of chapters a story can have.

Create

To create a Chapter under a story, click on your Story and click Add Chapter. You will then be presented with the Create Chapter View which has minimal options

  • Chapter Number [required] - This increases automatically
  • Title [Optional]
  • Chapter Body [Required]

Once you populate your Chapter, click Add Chapter.

Edit

To edit a Chapter under a story, click on your Story and click the Chapter under the Chapters list on the right. Once in you are viewing the Chapter, click Edit on the top right and you can edit the chapter.

Export

You can export an individal story, view the Story and click Export on the top right and choose HTML or Markdown.

Creating and Editing an Actor

Create

Note

For speed, you can also create an Actor during Story Creation, however you will need to Edit the actor afterwards to add any more details in.

To create a Actor, click Actors in the navigation bar and then click _Create Actor on the top right. You will then be presented with the Create Actor View which has a few options

  • Name [required]
  • Age [optional]
  • Description [optional]
  • Image [optional]

Once you fill out your details, click Create on the bottom right.

Edit

To edit a Actor, click on your Actor and click Edit on the top left. This view is (or should be) identical to the Actor Create View.

Editing Tags or Series

Note

Tags and Series can only be created in the Story Create or Story Edit View. Actors can be created here or on /actors.

To edit a Tag or Series, click on the specific Tag or Series and re-name it, then click Save on the bottom right.

System Management

Export

You can Export your stories via /system and click on the Export your stories which will download a compress archive (.zip) with all of your stories in .html format.

Database Backup

You can Download a Database Backup via /ssytem. This is a 1-1 copy of your Production database, which can be used for restores or data migration.

Reset System

Caution

This can not be reversed without a database backup!

This resets the system back to initial install, removing all stories, tags, series, actors, and your user account.

Logs

You can view your instance logs in /system, they can also be viewed in your docker volume mount.

Custom CSS

You can add custom styling/css by adding a mount to custom.css and creating the file. Any changes you make here will be taken after container restart, and will not be impacted by MyFicDB updates.

For more details see the docker-compose example in the Installation Guide.

Clone this wiki locally