Home

Welcome to the ByteStash wiki!

FAQ

Sorting & Filtering Options

ByteStash offers a bunch of nice-to-have filtering options, all options can be mix and matched, to really narrow things down:-

• Filter by Search
  • The search bar can filter snippets by name, description, and (optionally) code
  • The search bar can also be used to filter by category, type #category-name, then press enter to accept, multiple categories can be filtered at once
• Filter by Language
  • The languages dropdown can be used to search for snippets by language, the list contains every language in the available snippets
• Sort by Time
  • Order your snippets by update date so you can easily find new snippets

Plans:-

• Order snippets alphabetically by name

Settings

ByteStash can be configured to your liking all via the settings menu located in the top right of the main screen, see below for the settings and their descriptions:-

• Compact View
  • Reduces the footprint of the snippet previews
• Show Code Preview
  • Should the snippets show a code preview?
• Preview Lines
  • Only available if Show Code Preview is enabled
  • How many lines of code should be displayed? (1-20)
• Include Code in Search Queries
  • When searching with the search bar, should code be included in the search?
  • Can be disabled to narrow down a search, especially if your search contains a commonly used syntax word
• Show Categories
  • Should categories be shown on the snippet previews?
  • Categories will still be shown in the expanded snippet view
• Expand Categories
  • When the number of categories exceeds the screen size limit, they are normally truncated with a "Show all" button, this setting will automatically show all by default
• Show Line Numbers
  • Should line numbers be displayed in code previews / the code editor?
  • Does not work with Markdown, since this is rendered independently

Environment Variables

ByteStash has a few configurable environment variables used for various things:-

• AUTH_USERNAME
  • The username to use for authentication
• AUTH_PASSWORD
  • The password to use for authentication
• JWT_SECRET
  • The JWT secret to use for generating subsequent JWT tokens shared with the client
• TOKEN_EXPIRY
  • The amount of time a token given to a client is valid for
  • e.g. 2 days, 10h, 7d, 1m, 60s