### Start the NeoDB Cluster

Source: https://github.com/neodb-social/neodb/blob/main/docs/development.md

Start all services for the NeoDB cluster using the development profile. This command brings up the web servers and other necessary components.

```bash
docker compose --profile dev up -d
```

--------------------------------

### Install uv, Packages, and Pre-commit Hooks

Source: https://github.com/neodb-social/neodb/blob/main/docs/development.md

Install the uv package manager, synchronize project dependencies, activate the virtual environment, and set up pre-commit hooks for code quality.

```bash
curl -LsSf https://astral.sh/uv/install.sh | sh
uv sync
. .venv/bin/activate
pre-commit install
```

--------------------------------

### Download Docker Images and Start Services

Source: https://github.com/neodb-social/neodb/blob/main/docs/development.md

Pull the necessary Docker images and start the PostgreSQL, Redis, and Typesense services in detached mode. This prepares the database and cache infrastructure.

```bash
docker compose --profile dev pull
docker compose up -d
```

--------------------------------

### Preview Documentation with MkDocs

Source: https://github.com/neodb-social/neodb/blob/main/docs/development.md

Serve the MkDocs documentation locally to preview changes before deployment. Requires MkDocs to be installed.

```bash
python -m mkdocs serve
```

--------------------------------

### Test Docker Installation

Source: https://github.com/neodb-social/neodb/blob/main/docs/install.md

Ensure Docker is installed correctly and can run containers without sudo privileges.

```bash
docker run --rm hello-world
```

--------------------------------

### Email Sender Configuration Examples

Source: https://github.com/neodb-social/neodb/blob/main/docs/configuration.md

Examples of email sender configurations for the NEODB_EMAIL_URL setting. Supports standard SMTP, TLS, SSL, and Anymail backends.

```env
smtp://<username>:<password>@<host>:<port>
```

```env
smtp+tls://<username>:<password>@<host>:<port>
```

```env
smtp+ssl://<username>:<password>@<host>:<port>
```

```env
anymail://<anymail_backend_name>?<anymail_args>
```

--------------------------------

### Initialize and Configure Garage

Source: https://github.com/neodb-social/neodb/blob/main/docs/configuration.md

Commands to initialize Garage, assign node layout, and create buckets and keys. These commands are executed after the service starts.

```bash
# Assign node layout
docker compose exec garage /garage -c /etc/garage.toml status
docker compose exec garage /garage -c /etc/garage.toml layout assign -z dc1 -c 1G <node_id>
docker compose exec garage /garage -c /etc/garage.toml layout apply --version 1

# Create bucket and key
docker compose exec garage /garage -c /etc/garage.toml bucket create media
docker compose exec garage /garage -c /etc/garage.toml key create neodb-app-key
docker compose exec garage /garage -c /etc/garage.toml bucket allow --read --write --owner media --key neodb-app-key
docker compose exec garage /garage -c /etc/garage.toml bucket website --allow media
```

--------------------------------

### NodeInfo JSON Example

Source: https://github.com/neodb-social/neodb/blob/main/docs/internals/federation.md

Example of NodeInfo JSON response for a NeoDB instance, indicating supported protocols.

```json
{
  "version": "2.0",
  "software": {
    "name": "neodb",
    "version": "0.10.4.13",
    "repository": "https://github.com/neodb-social/neodb",
    "homepage": "https://neodb.net/"
  },
  "protocols": ["activitypub", "neodb"],
}
```

--------------------------------

### Clone NeoDB and Initialize Submodules

Source: https://github.com/neodb-social/neodb/blob/main/docs/development.md

Clone the NeoDB repository and ensure all submodules are initialized. This is a crucial first step before installing dependencies.

```bash
git clone https://github.com/neodb-social/neodb.git
cd neodb
git submodule update --init
```

--------------------------------

### Initialize Database Schema and Collect Static Files

Source: https://github.com/neodb-social/neodb/blob/main/docs/development.md

Run Django's `collectstatic` command to gather static files and then execute `neodb-init` to set up the database schema. These commands are essential after initial setup or code updates.

```bash
docker compose --profile dev run --rm dev-shell takahe-manage collectstatic --noinput
docker compose --profile dev run --rm dev-shell neodb-init
```

--------------------------------

### Create SeaweedFS Bucket

Source: https://github.com/neodb-social/neodb/blob/main/docs/configuration.md

Use the AWS CLI to create the 'media' bucket in SeaweedFS after the service has started. Ensure the endpoint URL matches your SeaweedFS configuration.

```bash
aws --endpoint-url http://localhost:8333 s3 mb s3://media
```

--------------------------------

### Add New Site Command Example

Source: https://github.com/neodb-social/neodb/blob/main/docs/internals/catalog.md

Command to run for debugging or saving response files to /tmp. Detailed code for the 'cat' command is located in catalog/management/commands/cat.py.

```bash
neodb-manage cat <url>
```

--------------------------------

### Passkey Registration Logic

Source: https://github.com/neodb-social/neodb/blob/main/users/templates/users/welcome.html

Initializes passkey registration if the browser supports it. It shows the passkey prompt, hides the accept button, and sets up an event listener for the passkey setup button. This code handles the entire passkey creation flow, including calling the registration options and verification URLs, and updating the UI based on success or failure.

```javascript
(function() { if (!window.Passkey || !Passkey.isSupported()) return; document.getElementById('passkey-prompt').style.display = ''; document.getElementById('accept-btn').style.display = 'none'; var btn = document.getElementById('passkey-setup-btn'); var status = document.getElementById('passkey-setup-status'); btn.addEventListener('click', function() { btn.setAttribute('aria-busy', 'true'); status.textContent = ''; Passkey.register( '{% url "users:passkey_register_options" %}', '{% url "users:passkey_register_verify" %}', function() { btn.removeAttribute('aria-busy'); btn.disabled = true; btn.textContent = '{% trans "Passkey created" %}'; }, function(err) { btn.removeAttribute('aria-busy'); if (err) status.textContent = err; } ); }); })();
```

--------------------------------

### Initialize Shikwasa Podcast Player

Source: https://github.com/neodb-social/neodb/blob/main/catalog/templates/embed_podcast.html

Initializes the Shikwasa player with episode details and autoplay enabled. Use this when embedding a podcast player that should start playing immediately.

```javascript
$(function(){
  if (focus_item) {
    var position = 1 * "{{request.GET.position|escapejs}}";
    window.current_item_uuid = "{{focus_item.uuid}}";
    window.player = new Shikwasa.Player({
      container: () => document.querySelector('body'),
      preload: 'metadata',
      autoplay: true,
      theme: 'dark',
      themeColor: '#837FFF',
      audio: {
        title: "{{ focus_item.display_title | escapejs }}",
        cover: "{{ focus_item.cover_url | default:item.cover.url | escapejs }}",
        src: "{{ focus_item.media_url | escapejs }}",
        album: "{{ item.display_title|escapejs }}",
        artist: "{{ item.host_names|join:' / '|escapejs }}"
      }
    });
    if (position) window.player._initSeek = position;
  }
});
```

--------------------------------

### Configure Development Environment Variables

Source: https://github.com/neodb-social/neodb/blob/main/docs/development.md

Set up the necessary environment variables in a `.env` file for local development. Ensure these variables are present before starting the Docker services.

```dotenv
NEODB_SITE_NAME="My Test"
NEODB_SITE_DOMAIN=mydomain.dev
NEODB_SECRET_KEY=_random_string__50_characters_of_length__no_whitespaces_
NEODB_IMAGE=neodb/neodb:edge
NEODB_DEBUG=True
```

--------------------------------

### Accessing NeoDB APIs

Source: https://github.com/neodb-social/neodb/blob/main/common/templates/console.html

Information on how to authorize API requests and examples of using access tokens.

```APIDOC
## Accessing NeoDB APIs

### Description
Invoke APIs with your account by authorizing with an access token. This is required for APIs like `/api/me`.

### Authorization
Click the `Authorize` button and input your token. Alternatively, use it in the command line.

### Command Line Example
```bash
curl -H "Authorization: Bearer YOUR_TOKEN" {{ site_url }}/api/me
```

### Further Details
Please check [NeoDB documentation](https://neodb.net/api/) for details on how to authorize.
```

--------------------------------

### Authorize user

Source: https://github.com/neodb-social/neodb/blob/main/docs/api.md

Guide your user to open the authorization URL to grant your application access.

```APIDOC
## Guide your user to open this URL

```
https://neodb.social/oauth/authorize?response_type=code&client_id=CLIENT_ID&redirect_uri=https://example.org/callback&scope=read+write
```

### Once authorizated by user, it will redirect to `https://example.org/callback` with a `code` parameter:

```
https://example.org/callback?code=AUTH_CODE
```
```

--------------------------------

### Markdown Formatting Examples

Source: https://github.com/neodb-social/neodb/blob/main/journal/templates/markdown_editor.html

Demonstrates various Markdown syntax elements including links, emphasis, highlights, quotes, lists, code blocks, tables, and images. Use these for reference when writing Markdown.

```markdown
{% load i18n %}
**{% trans "Markdown format references" %}**

{% blocktrans %}
## Subtitle

  Paragraphs need to be separated by a blank line

[Link](https://zh.wikipedia.org/wiki/Markdown)

**Bold**  *Italic* ~~Strikethrough~~

==Highlight==  ^Super^script ~Sub~script

> Quote
>> Multi-level quote

Inline >! spoiler warning !<

>! Multi-line
>! Spoiler

---

- Bullet
- Points

```
code
```

Table Header  | Second Header
------------- | -------------
Content Cell  | Content Cell
Content Cell  | Content Cell

Paste or upload an image ![Image](https://upload.wikimedia.org/wikipedia/en/8/80/Wikipedia-logo-v2.svg)

{% endblocktrans %}
```

--------------------------------

### Verify Docker Compose Version

Source: https://github.com/neodb-social/neodb/blob/main/docs/install.md

Check if Docker Compose is installed and meets the minimum version requirement (2.x or higher).

```bash
docker compose version
```

--------------------------------

### Passkey Nudge Logic

Source: https://github.com/neodb-social/neodb/blob/main/common/templates/_header.html

Manages the display and dismissal of a passkey setup prompt for authenticated users. Ensures the prompt is shown only once per session.

```javascript
(function() {
    if (!window.PublicKeyCredential || sessionStorage.getItem('passkey_nudge_dismissed')) return;
    var el = document.getElementById('passkey-nudge');
    if (el) el.style.display = '';
    var dismiss = document.getElementById('passkey-nudge-dismiss');
    if (dismiss) dismiss.addEventListener('click', function(e) {
        e.preventDefault();
        sessionStorage.setItem('passkey_nudge_dismissed', '1');
        el.style.display = 'none';
    });
})();
```

--------------------------------

### Get Search Index Information

Source: https://github.com/neodb-social/neodb/blob/main/docs/usage/catalog.md

Displays information about the current state and configuration of the search index.

```bash
neodb-manage catalog idx-info
```

--------------------------------

### Authorize User URL

Source: https://github.com/neodb-social/neodb/blob/main/docs/api.md

Construct this URL to guide your user through the OAuth authorization process. Replace CLIENT_ID and redirect_uri with your application's specific values.

```url
https://neodb.social/oauth/authorize?response_type=code&client_id=CLIENT_ID&redirect_uri=https://example.org/callback&scope=read+write
```

--------------------------------

### Initialize Calendar View with Data and Options

Source: https://github.com/neodb-social/neodb/blob/main/journal/templates/calendar_data.html

Initializes the calendar view using jQuery and a JSON data source. Configure start day, tooltip behavior, and custom month/day names. Define specific colors for event types like 'book', 'movie', etc., falling back to a default form element background color.

```javascript
{% load i18n %} {{ calendar_data|json_script:"calendar_data" }}
$(".calendar_view").calendar_yearview_blocks({
  data: $("#calendar_data").text(),
  start_monday: false,
  always_show_tooltip: false,
  month_names: [
    '{% trans "JAN" %}',
    '{% trans "FEB" %}',
    '{% trans "MAR" %}',
    '{% trans "APR" %}',
    '{% trans "MAY" %}',
    '{% trans "JUN" %}',
    '{% trans "JUL" %}',
    '{% trans "AUG" %}',
    '{% trans "SEP" %}',
    '{% trans "OCT" %}',
    '{% trans "NOV" %}',
    '{% trans "DEC" %}'
  ],
  day_names: ['', '', ''],
  colors: {
    'default': getComputedStyle(document.documentElement).getPropertyValue('--pico-form-element-background-color'),
    'book': '#B4D2A5',
    'movie': '#7CBDFE',
    'tv': '#FDDB23',
    'music': '#FEA36D',
    'game': '#C5A290',
    'podcast': '#9D6AB0',
    'performance': '#FE7C7C',
    'other': '#FED37C'
  }
});
```

--------------------------------

### Obtain Access Token

Source: https://github.com/neodb-social/neodb/blob/main/docs/api.md

Send a POST request with your application credentials and the authorization code to this endpoint to get an access token. This token is used to authenticate API requests.

```bash
curl https://neodb.social/oauth/token \
	-d "client_id=CLIENT_ID" \
	-d "client_secret=CLIENT_SECRET" \
	-d "code=AUTH_CODE" \
	-d "redirect_uri=https://example.org/callback" \
	-d "grant_type=authorization_code"
```

--------------------------------

### Get Current Language

Source: https://github.com/neodb-social/neodb/blob/main/journal/templates/wrapped.html

Retrieves the current language code for internationalization purposes.

```django
{% get_current_language as LANGUAGE_CODE %}
```

--------------------------------

### Create an application

Source: https://github.com/neodb-social/neodb/blob/main/docs/api.md

Register a new application to obtain client credentials for API access.

```APIDOC
## Create an application

You must have at least one URL included in the Redirect URIs field, e.g. `https://example.org/callback`, or use `urn:ietf:wg:oauth:2.0:oob` if you don't have a callback URL.

```
curl https://neodb.social/api/v1/apps \
  -d client_name=MyApp \
  -d redirect_uris=https://example.org/callback \
  -d website=https://my.site
```

and save of the `client_id` and `client_secret` returned in the response:

```
{
  "client_id": "CLIENT_ID",
  "client_secret": "CLIENT_SECRET",
  "name": "MyApp",
  "redirect_uri": "https://example.org/callback",
  "vapid_key": "PUSH_KEY",
  "website": "https://my.site"
}
```
```

--------------------------------

### Get current user information

Source: https://github.com/neodb-social/neodb/blob/main/docs/api.md

Retrieve information about the currently authenticated user.

```APIDOC
### Use the access token to access protected endpoints like `/api/me`

```
curl -H "Authorization: Bearer ACCESS_TOKEN" -X GET https://neodb.social/api/me
```

and response will be returned accordingly:

```
{"url": "https://neodb.social/users/xxx/", "external_acct": "xxx@yyy.zzz", "display_name": "XYZ", "avatar": "https://yyy.zzz/xxx.gif"}
```
```

--------------------------------

### Create Superuser Account

Source: https://github.com/neodb-social/neodb/blob/main/docs/accounts.md

Execute this command to create a superuser account. Alternatively, configure the NEODB_ADMIN_HANDLES environment variable to automatically promote users with matching handles upon registration.

```bash
docker compose --profile production run --rm shell neodb-manage createsuperuser
```

```dotenv
NEODB_ADMIN_HANDLES=mastodon:user@mastodon.social,email:admin@example.com
```

--------------------------------

### List All Accounts

Source: https://github.com/neodb-social/neodb/blob/main/docs/accounts.md

Use this command to view all accounts on your instance. Be aware that this output includes sensitive information such as email addresses and fediverse accounts.

```bash
docker compose --profile production run --rm shell neodb-manage user --list
```

--------------------------------

### Protected Endpoint Response Example

Source: https://github.com/neodb-social/neodb/blob/main/docs/api.md

A successful request to a protected endpoint will return data related to the authenticated user or resource.

```json
{"url": "https://neodb.social/users/xxx/", "external_acct": "xxx@yyy.zzz", "display_name": "XYZ", "avatar": "https://yyy.zzz/xxx.gif"}
```

--------------------------------

### Toggle Account to Admin

Source: https://github.com/neodb-social/neodb/blob/main/docs/accounts.md

Promote an existing user account to admin status. Exercise caution, as admins have extensive control over the instance.

```bash
docker compose --profile production run --rm shell neodb-manage user --super [USERNAME]
```

--------------------------------

### Conditional Display of Episode Comments

Source: https://github.com/neodb-social/neodb/blob/main/catalog/templates/_item_comments_by_episode.html

Conditionally displays episode comments if the 'last' GET parameter is not present. Otherwise, it shows a link to comment.

```html
{% if not request.GET.last %}

{% trans "this season" %} {% for ep in item.all_episodes %} {{ ep.episode_number }} {% endfor %}

[{% if mark.comment_text %} {% else %} {% endif %} {% trans "comment this episode" 
](#)

$(function(){ window.cil.forEach(function(uuid){ $('#ci_'+uuid).addClass('marked'); }) }); {% endif %}
```

--------------------------------

### Initialize Database Schema using neodb-init

Source: https://github.com/neodb-social/neodb/blob/main/docs/development.md

Update the database schema using the `neodb-init` command. This is the recommended way to migrate the database after code updates, rather than using `python3 manage.py migrate` directly.

```bash
neodb-shell neodb-init
```

--------------------------------

### Passkey Login Initialization and Event Handling

Source: https://github.com/neodb-social/neodb/blob/main/users/templates/users/login.html

Initializes the passkey login button, checks for passkey support, and attaches a click event listener to initiate the passkey login process. It handles success and error callbacks.

```javascript
(function() {
    if (!window.Passkey || !Passkey.isSupported()) return;
    var btn = document.getElementById('passkey-login-btn');
    if (!btn) return;
    btn.addEventListener('click', function() {
        localStorage.login_method = 'passkey';
        btn.setAttribute('aria-busy', 'true');
        var errEl = document.getElementById('passkey-error');
        errEl.style.display = 'none';
        Passkey.login(
            '{% url "users:passkey_login_options" %}',
            '{% url "users:passkey_login_verify" %}',
            function(result) {
                location.href = result.redirect || '/';
            },
            function(err) {
                btn.removeAttribute('aria-busy');
                if (err) {
                    errEl.textContent = err;
                    errEl.style.display = '';
                }
            }
        );
    });
})();
```

--------------------------------

### Testing Storage Configuration

Source: https://github.com/neodb-social/neodb/blob/main/docs/configuration.md

Run this command to test your configured storage backend, ensuring files can be uploaded and accessed.

```bash
neodb-manage catalog storage-test
```

--------------------------------

### Initialize Search Index

Source: https://github.com/neodb-social/neodb/blob/main/docs/usage/catalog.md

Checks if the search index exists and creates it if it is missing.

```bash
neodb-manage catalog idx-init
```

--------------------------------

### Initialize and Save Device Settings (JavaScript)

Source: https://github.com/neodb-social/neodb/blob/main/users/templates/users/_pref_device.html

This script initializes UI elements based on local storage and cookie values for theme, custom styles, focus mode, demetrication, and items per page. It also includes a function to save these settings.

```javascript
var _c=$('html').attr('data-theme')||""; if (_c=="light") $('input[id=theme_light]').prop('checked', true); if (_c=="dark") $('input[id=theme_dark]').prop('checked', true); if (! _c) $('input[id=theme_auto]').prop('checked', true); $("#user_style").val(localStorage.getItem("user_style")||""); $("#solo_mode").prop("checked", localStorage.getItem("solo_mode")=="1"); $("#demetrication").prop("checked", localStorage.getItem("demetrication")=="1"); var _p=Cookies.get('per_page') || 20; $('#'+_p+'_per_page').prop('checked', true); function save_local() { var _c=$('input[name=theme_color]:checked').val(); $('html').attr('data-theme', _c||""); localStorage.setItem("theme_color", _c); localStorage.setItem("user_style", $("#user_style").val()); localStorage.setItem("solo_mode", $("#solo_mode").prop("checked")?"1":"0"); localStorage.setItem("demetrication", $("#demetrication").prop("checked")?"1":"0"); Cookies.set('per_page', $('input[name=per_page]:checked').val(), {expires: 120, sameSite: 'Lax'}); alert("{% trans 'Settings for current device saved' %}"); }
```

--------------------------------

### Create NeoDB Application

Source: https://github.com/neodb-social/neodb/blob/main/docs/api.md

Use this cURL command to create a new application on NeoDB. Ensure you provide a client name, redirect URIs, and optionally a website.

```bash
curl https://neodb.social/api/v1/apps \
  -d client_name=MyApp \
  -d redirect_uris=https://example.org/callback \
  -d website=https://my.site
```

--------------------------------

### Local Storage URL History Management

Source: https://github.com/neodb-social/neodb/blob/main/catalog/templates/scraper_debug.html

Manages a history of scraped URLs using local storage. Includes functions to get, save, clear, and update the UI for URL history, with a maximum limit.

```javascript
let currentMode = 'site'; const HISTORY_KEY = 'scraper_debug_url_history'; const MAX_HISTORY = 20; function getHistory() { try { return JSON.parse(localStorage.getItem(HISTORY_KEY)) || []; } catch { return []; } } function saveToHistory(url) { if (!url) return; let history = getHistory(); history = history.filter(u => u !== url); history.unshift(url); if (history.length > MAX_HISTORY) history = history.slice(0, MAX_HISTORY); localStorage.setItem(HISTORY_KEY, JSON.stringify(history)); updateHistoryUI(); } function clearHistory() { localStorage.removeItem(HISTORY_KEY); updateHistoryUI(); } function updateHistoryUI() { const history = getHistory(); const datalist = document.getElementById('url-history'); const actionsEl = document.getElementById('history-actions'); datalist.innerHTML = history.map(url => `<option value="${url}">`).join(''); actionsEl.style.display = history.length > 0 ? 'block' : 'none';
```

--------------------------------

### Set Garage Environment Variables

Source: https://github.com/neodb-social/neodb/blob/main/docs/configuration.md

Configure the `.env` file with settings for the Garage backend, including the S3 endpoint and the public media URL. Use the key ID and secret obtained from `key create`.

```env
MEDIA_BACKEND=s3-insecure://KEY_ID:SECRET_KEY@garage:3900/media
MEDIA_URL=https://media.my.media.domain/"
```

--------------------------------

### Initialize Autocomplete for Domain Input

Source: https://github.com/neodb-social/neodb/blob/main/users/templates/users/login.html

Sets up an autocomplete input for the domain field, using provided site data. It handles user selection to populate the input and enables form submission.

```javascript
const sites = JSON.parse(document.getElementById('sites-data').textContent);
const autoCompleteJS = new autoComplete({
    placeHolder: "{% trans 'Domain of your instance (excl. @)' %}",
    selector: "#domain",
    // wrapper: false,
    data: {
        src: sites
    },
    submit: true,
    resultsList: {
        tabSelect: true,
        maxResults: 10
    },
    events: {
        input: {
            selection: (event) => {
                const selection = event.detail.selection.value;
                autoCompleteJS.input.value = selection;
            }
        }
    }
});
```

--------------------------------

### Federated Shelf Envelope Example

Source: https://github.com/neodb-social/neodb/blob/main/docs/internals/federation.md

This JSON structure represents a federated Shelf envelope within an announcement Note. It includes details about the collection or shelf, such as total items, pagination links, and content-specific fields like description, shelf type, or query.

```json
{
  "@context": ["https://www.w3.org/ns/activitystreams", {
    "blurhash": "toot:blurhash",
    "Emoji": "toot:Emoji",
    "focalPoint": {
      "@container": "@list",
      "@id": "toot:focalPoint"
    },
    "Hashtag": "as:Hashtag",
    "manuallyApprovesFollowers": "as:manuallyApprovesFollowers",
    "sensitive": "as:sensitive",
    "toot": "http://joinmastodon.org/ns#",
    "votersCount": "toot:votersCount",
    "featured": {
      "@id": "toot:featured",
      "@type": "@id"
    }
  }, "https://w3id.org/security/v1"],
  "id": "https://neodb.social/@april_long_face@neodb.social/posts/380919151408919488/",
  "type": "Note",
  "relatedWith": [{
    "id": "https://neodb.social/p/5oyF0qRx96mKKmVpFzHtMM",
    "type": "Status",
    "status": "complete",
    "withRegardTo": "https://neodb.social/movie/7hfF7d0aFMaqHpFjUpq4zR",
    "attributedTo": "https://neodb.social/@april_long_face@neodb.social/",
    "href": "https://neodb.social/p/5oyF0qRx96mKKmVpFzHtMM",
    "published": "2024-11-17T10:16:42.745240+00:00",
    "updated": "2024-11-17T10:16:42.750917+00:00"
  }, {
    "id": "https://neodb.social/p/47cJnbQTkbSSN2izLwQMjo",
    "type": "Comment",
    "withRegardTo": "https://neodb.social/movie/7hfF7d0aFMaqHpFjUpq4zR",
    "attributedTo": "https://neodb.social/@april_long_face@neodb.social/",
    "content": "Broadway cin\u00e9math\u00e8que, at least I laughed hard.",
    "href": "https://neodb.social/p/47cJnbQTkbSSN2izLwQMjo",
    "published": "2024-11-17T10:16:42.745240+00:00",
    "updated": "2024-11-17T10:16:42.777276+00:00"
  }, {
    "id": "https://neodb.social/p/3AyYu974qo6OU09AAsPweQ",
    "type": "Rating",
    "best": 10,
    "value": 7,
    "withRegardTo": "https://neodb.social/movie/7hfF7d0aFMaqHpFjUpq4zR",
    "worst": 1,
    "attributedTo": "https://neodb.social/@april_long_face@neodb.social/",
    "href": "https://neodb.social/p/3AyYu974qo6OU09AAsPweQ",
    "published": "2024-11-17T10:16:42.784220+00:00",
    "updated": "2024-11-17T10:16:42.786458+00:00"
  }],
  "attributedTo": "https://neodb.social/@april_long_face@neodb.social/",
  "content": "<p>\u770b\u8fc7 <a href=\"https://neodb.social/~neodb~/movie/7hfF7d0aFMaqHpFjUpq4zR\" rel=\"nofollow\">\u963f\u8bfa\u62c9</a> \ud83c\udf15\ud83c\udf15\ud83c\udf15\ud83c\udf17\ud83c\udf11  <br>Broadway cin\u00e9math\u00e8que, at least I laughed hard.</p><p><a href=\"https://neodb.social/tags/\u6211\u770b\u6211\u542c\u6211\u8bfb/\" class=\"mention hashtag\" rel=\"tag\">#\u6211\u770b\u6211\u542c\u6211\u8bfb</a></p>",
  "published": "2024-11-17T10:16:42.745Z",
  "sensitive": false,
  "tag": [{
    "type": "Hashtag",
    "href": "https://neodb.social/tags/\u6211\u770b\u6211\u542c\u6211\u8bfb/",
    "name": "#\u6211\u770b\u6211\u542c\u6211\u8bfb"
  }, {
    "type": "Movie",
    "href": "https://neodb.social/movie/7hfF7d0aFMaqHpFjUpq4zR",
    "image": "https://neodb.social/m/item/doubanmovie/2024/09/13/a30bf2f3-4f79-43ef-b22f-58ebc3fd8aae.jpg",
    "name": "Anora"
  }],
  "to": ["https://www.w3.org/ns/activitystreams#Public"],
  "updated": "2024-11-17T10:16:42.750Z",
  "url": "https://neodb.social/@april_long_face/posts/380919151408919488/"
}
```

--------------------------------

### Access Neodb Container Shell

Source: https://github.com/neodb-social/neodb/blob/main/docs/troubleshooting.md

Run a shell inside the Neodb cluster to investigate issues. Use 'docker compose run shell' for a standard shell or 'docker compose run root' for root access. The 'apt' package manager is available for installing additional tools if needed.

```bash
docker compose run shell
```

```bash
docker compose run root
```

--------------------------------

### Configure Garage Storage Service

Source: https://github.com/neodb-social/neodb/blob/main/docs/configuration.md

Add this configuration to your `compose.override.yml` to set up the Garage S3-compatible storage engine. Ensure a `garage.toml` file is created and properly configured.

```yaml
services:
  garage:
    image: dxflrs/garage:v2.2.0
    volumes:
      - ${NEODB_DATA:-../data}/garage/garage.toml:/etc/garage.toml
      - ${NEODB_DATA:-../data}/garage/data:/var/lib/garage/data
      - ${NEODB_DATA:-../data}/garage/meta:/var/lib/garage/meta
    ports:
      - 3900:3900
      - 3902:3902
```

--------------------------------

### Run Catalog Migration Scripts

Source: https://github.com/neodb-social/neodb/blob/main/docs/usage/catalog.md

Executes specified migration scripts for the catalog. Use the `--name` flag to select the migration, such as 'merge_works'.

```bash
neodb-manage catalog migrate --name merge_works
```

--------------------------------

### Initialize Login State and UI

Source: https://github.com/neodb-social/neodb/blob/main/users/templates/users/login.html

Restores login state from local storage or cookies, dynamically shows/hides form sections based on the selected login method, and handles passkey support detection.

```javascript
$(function(){
    var selected_domain = '{{selected_domain}}';
    var method = localStorage.login_method;
    if (!!selected_domain) {
        method = "mastodon";
        $('#domain').val(selected_domain);
    } else if (!!method) {
        $('#domain').val(localStorage.mastodon_domain);
        $('#email').val(localStorage.email);
    } else {
        // restire cookie from previous versions
        var d = Cookies.get('mastodon_domain');
        if (d) {
            if (d == "@") {
                method = "email";
            } else {
                method = "mastodon";
                $('#domain').val(Cookies.get('mastodon_domain'));
            }
        }
    }
    if (method === 'passkey' && !window.PublicKeyCredential) {
        method = null;
    }
    if (!!method) {
        $('article form').hide();
        $('#platform-' + method).removeClass('outline');
        $('#login-' + method).show();
    }
})
```

--------------------------------

### Application Creation Response

Source: https://github.com/neodb-social/neodb/blob/main/docs/api.md

The response from creating an application contains essential credentials like client_id and client_secret, which are needed for subsequent authorization steps.

```json
{
  "client_id": "CLIENT_ID",
  "client_secret": "CLIENT_SECRET",
  "name": "MyApp",
  "redirect_uri": "https://example.org/callback",
  "vapid_key": "PUSH_KEY",
  "website": "https://my.site"
}
```

--------------------------------

### Initialize Swagger UI

Source: https://github.com/neodb-social/neodb/blob/main/common/templates/console.html

Initializes the Swagger UI for API documentation. Includes request interceptor for CSRF tokens if enabled.

```javascript
const ui = SwaggerUIBundle({
  url: '{{ openapi_json_url }}',
  dom_id: '#swagger-ui',
  presets: [
    SwaggerUIBundle.presets.apis,
    SwaggerUIBundle.SwaggerUIStandalonePreset
  ],
  layout: "BaseLayout",
  {% if api.csrf and csrf_token %} requestInterceptor: (req) => {
    req.headers['X-CSRFToken'] = "{{csrf_token}}";
    return req;
  },
  {% endif %}
  deepLinking: true
})
```

--------------------------------

### Set NeoDB Site Domain for GitHub Codespaces

Source: https://github.com/neodb-social/neodb/blob/main/docs/development.md

Configure the `NEODB_SITE_DOMAIN` environment variable in `.env` for GitHub Codespaces to correctly map the domain using port forwarding.

```bash
NEODB_SITE_DOMAIN=${CODESPACE_NAME}-8000.${GITHUB_CODESPACES_PORT_FORWARDING_DOMAIN}
```

--------------------------------

### Display Item Overview

Source: https://github.com/neodb-social/neodb/blob/main/catalog/templates/item_base.html

Shows the item's main description or the parent item's description if the item itself lacks one. Includes a 'show more' link.

```html
{% block details %} 

{% trans 'Unsupported item type.' %}

UUID: {{ item.uuid }}

Class: {{ item.class_name }}

Category: {{ item.category }}

{% endblock %} {% if request.user.is_authenticated %}

{% if not item.is_protected or request.user.is_staff %} []({% url 'catalog:edit' item.url_path item.uuid %} "{% trans 'Edit this item' %}"){% else %} {% endif %} {% if item.last_editor and item.last_editor.preference.show_last_edit %} {% trans 'Last edited' %}: [{{ item.last_editor.display_name | default:""}}]({{ item.last_editor.url }}) {% endif %}

{% endif %} {% block rating_and_tags %}

### {{ item.rating | floatformat:1 }} / 10

{{ item.rating_count }} {% trans 'ratings' %}

{% trans 'No enough ratings' %}

{% for tag in item.tags %} [{{ tag }}]({% url 'common:search' %}?tag={{ tag|urlencode }}) {% endfor %}

{% endblock %} {% block left_sidebar %}{% endblock %} {% if item.display_subtitle %}

{{ item.display_subtitle }}

{% endif %} {% if item.orig_title and item.orig_title != item.display_title %}

{{ item.orig_title }} {% if item.season_number %}Season {{ item.season_number }}{% endif %}

{% endif %} {% if item.parent_item and item.type.value != 'edition' %} {% trans 'part of' %} {{ item.parent_item.type.label }}: []({{ item.parent_item.url }})[{{ item.parent_item.display_title }}]({{ item.parent_item.url }}) {% endif %} {% if item.role_credits.author %}

_{% include '_credits.html' with credits=item.role_credits.author max=2 %}_     _{% include '_credits.html' with credits=item.role_credits.translator max=2 %}_

{% endif %}

##### {% trans 'overview' %}

 {% if item.display_description %}

{{ item.display_description | linebreaksbr }}

{% elif item.parent_item.display_description %}

{{ item.parent_item.display_description | linebreaksbr }}

{% else %}

{% trans 'nothing so far.' %}

{% endif %} {% trans "show more" %}
```

--------------------------------

### Promote User to Superuser

Source: https://github.com/neodb-social/neodb/blob/main/docs/install.md

Manually promote an existing user to a superuser if automatic promotion via `NEODB_ADMIN_HANDLES` is not configured. Replace 'admin' with the desired username.

```bash
docker compose --profile production run --rm shell neodb-manage user --super admin
```

--------------------------------

### View Container Logs

Source: https://github.com/neodb-social/neodb/blob/main/docs/install.md

Monitor the real-time logs of the NeoDB services, useful for debugging.

```bash
docker compose --profile production logs -f
```

--------------------------------

### Initialize Key-Value Input Widget

Source: https://github.com/neodb-social/neodb/blob/main/common/templates/widgets/hstore.html

Initializes the HStore widget's key-value input functionality using jQuery selectors. Ensure the target elements exist before calling this function.

```javascript
keyValueInput( $(".widget-value-key-input[name='{{ widget.name }}']"), $(".widget-value-key-input-data[name='{{ widget.name }}']") );
```

--------------------------------

### Initialize Stacked Bar Chart

Source: https://github.com/neodb-social/neodb/blob/main/journal/templates/wrapped.html

Configures and initializes a roughViz StackedBar chart with specified data, labels, colors, and layout options. Requires the 'roughViz' library.

```javascript
var cats = JSON.parse(document.getElementById('cat-data').textContent);
var data = JSON.parse(document.getElementById('data').textContent);
var opts = {
    title: "@{{ identity.user.mastodon.handle | default:identity.full_handle }} - {{ year }}",
    element: '#viz0',
    font: 1,
    data: data,
    labels: "Month",
    highlight: "#666",
    stackColorMapping: {
        '📚': '#B4D2A5',
        '🎬': '#7CBDFE',
        '📺': '#FED37C',
        '💿': '#FEA36D',
        '🎮': '#C5A290',
        '🎙️': '#9D6AB0',
        '🎭': '#FE7C7C',
        'x': '#FDDB23',
    },
    roughness: 1,
    fillStyle: 'solid',
    margin: { top: 80, left: 20, right: 20, bottom: 80 },
    stroke: 1,
    padding: 0.2,
    color: 'red',
    strokeWidth: 1,
    axisStrokeWidth: 1,
    innerStrokeWidth: 1,
    fillWeight: 1,
    axisRoughness: 1,
    yLabel:"",
};
var viz0 = new roughViz.StackedBar(opts);
```

--------------------------------

### Load Static and Translation Tags

Source: https://github.com/neodb-social/neodb/blob/main/catalog/templates/_item_comments_by_episode.html

Loads necessary template tags for static files, internationalization, and localization.

```html
{% load static %}
{% load i18n %}
{% load l10n %}
{% load mastodon %}
{% load duration %}
{% load user_actions %}
```

--------------------------------

### Check Docker Container Status

Source: https://github.com/neodb-social/neodb/blob/main/docs/troubleshooting.md

Use this command to verify if any Neodb services are running or have stopped. It's normal for the 'migration' service to show an 'Exit 0' state.

```bash
docker compose ps
```

--------------------------------

### Client-side User Preference Management

Source: https://github.com/neodb-social/neodb/blob/main/common/templates/common_libs.html

Initializes client-side styles and settings based on localStorage values. Handles user style, solo mode, demetrication, and theme color.

```javascript
(function(){
const s = localStorage.getItem("user_style");
if (s) {
// Use textContent so any closing-style-tag sequence is treated as
// text, preventing the value from terminating the style element.
const style = document.createElement("style");
style.textContent = s;
document.head.appendChild(style);
}
const solo = localStorage.getItem("solo_mode")=="1";
if (solo) {
const style = document.createElement("style");
style.textContent = ".solo-hidden {display: none;}\n" +
".notification-dot {display: none !important;}\n";
document.head.appendChild(style);
}
const demetrication = localStorage.getItem("demetrication")=="1";
if (demetrication) {
const style2 = document.createElement("style");
style2.textContent = ".metrics {display: none;}";
document.head.appendChild(style2);
}
$('html').attr('data-theme', localStorage.getItem("theme_color")||null)
})();
```

--------------------------------

### Configure Docker Compose for Development

Source: https://github.com/neodb-social/neodb/blob/main/docs/development.md

This configuration snippet for `compose.override.yml` exposes the NeoDB and Takahe web servers directly from the Docker containers to the host machine on specified ports.

```yaml
services:
  dev-neodb-web:
    ports:
      - "8001:8000"

  dev-takahe-web:
    ports:
      - "8002:8000"
```

--------------------------------

### Check NodeInfo Endpoint

Source: https://github.com/neodb-social/neodb/blob/main/docs/install.md

Verify that the NeoDB server is running by querying its NodeInfo endpoint locally.

```bash
curl http://localhost:8000/nodeinfo/2.0/
```

--------------------------------

### Configure Docker Compose for External Services

Source: https://github.com/neodb-social/neodb/blob/main/docs/configuration.md

Use this override file to run Neodb services while connecting to existing external PostgresQL, Redis, or Typesense instances. Ensure `extra_hosts` is configured if these services are on your host machine.

```yaml
services:
  redis:
    profiles: ['disabled']
  typesense:
    profiles: ['disabled']
  neodb-db:
    profiles: ['disabled']
  takahe-db:
    profiles: ['disabled']
  migration:
    extra_hosts:
      - "host.docker.internal:host-gateway"
    depends_on: !reset []
  neodb-web:
    extra_hosts:
      - "host.docker.internal:host-gateway"
    depends_on: !reset []
    healthcheck: !reset {}
  neodb-web-api:
    extra_hosts:
      - "host.docker.internal:host-gateway"
    depends_on: !reset []
    healthcheck: !reset {}
  neodb-worker:
    extra_hosts:
      - "host.docker.internal:host-gateway"
    depends_on: !reset []
  neodb-worker-extra:
    extra_hosts:
      - "host.docker.internal:host-gateway"
    depends_on: !reset []
  takahe-web:
    extra_hosts:
      - "host.docker.internal:host-gateway"
    depends_on: !reset []
  takahe-stator:
    extra_hosts:
      - "host.docker.internal:host-gateway"
    depends_on: !reset []
  shell:
    extra_hosts:
      - "host.docker.internal:host-gateway"
    depends_on: !reset []
  root:
    extra_hosts:
      - "host.docker.internal:host-gateway"
    depends_on: !reset []
  dev-neodb-web:
    extra_hosts:
      - "host.docker.internal:host-gateway"
    depends_on: !reset []
  dev-neodb-worker:
    extra_hosts:
      - "host.docker.internal:host-gateway"
    depends_on: !reset []
  dev-takahe-web:
    extra_hosts:
      - "host.docker.internal:host-gateway"
    depends_on: !reset []
  dev-takahe-stator:
    extra_hosts:
      - "host.docker.internal:host-gateway"
    depends_on: !reset []
  dev-shell:
    extra_hosts:
      - "host.docker.internal:host-gateway"
    depends_on: !reset []
  dev-root:
    extra_hosts:
      - "host.docker.internal:host-gateway"
    depends_on: !reset []

```

--------------------------------

### Initialize Barcode Scanner

Source: https://github.com/neodb-social/neodb/blob/main/common/templates/common/scan.html

This JavaScript code initializes camera access and attempts to use the native BarcodeDetector API. If unavailable, it falls back to the ZXing library. Handles camera permissions and errors.

```javascript
(function () { var video = document.getElementById("scan-video"); var statusEl = document.getElementById("scan-status"); var searchUrl = "{% url 'common:search' %}"; var formats = ["ean_13", "ean_8", "upc_a", "upc_e"];
var stream = null;
var stopped = false;
function setStatus(msg) { statusEl.textContent = msg; }
function isValidBookCode(code) { if (!code) return false; var digits = code.replace(/[-\s]/g, ""); // EAN-13 / ISBN-13, UPC-A (12), ISBN-10 (allow trailing X), EAN-8 / UPC-E (8) return /^\d{13}$/.test(digits) || /^\d{12}$/.test(digits) || /^\d{9}[\dX]$/i.test(digits) || /^\d{8}$/.test(digits); }
function redirect(code) { if (stopped) return; if (!isValidBookCode(code)) return; stopped = true; stopStream(); var url = searchUrl + "?q=" + encodeURIComponent(code) + "&c=book"; window.location.href = url; }
function stopStream() { if (stream) { stream.getTracks().forEach(function (t) { t.stop(); }); stream = null; } }
function startCamera() { if (!navigator.mediaDevices || !navigator.mediaDevices.getUserMedia) { setStatus("{% translate 'Camera not supported on this device. Use manual entry below.' %}"); return Promise.reject(new Error("no getUserMedia")); } return navigator.mediaDevices.getUserMedia({ video: { facingMode: { ideal: "environment" } }, audio: false }).then(function (s) { stream = s; video.srcObject = s; return video.play(); }); }
function runNativeDetector() { if (!("BarcodeDetector" in window)) return false; var detector; try { detector = new window.BarcodeDetector({ formats: formats }); } catch (e) { return false; } setStatus("{% translate 'Scanning...' %}"); var loop = function () { if (stopped) return; detector.detect(video).then(function (codes) { if (codes && codes.length > 0) { redirect(codes[0].rawValue); } if (!stopped) requestAnimationFrame(loop); }).catch(function () { if (!stopped) requestAnimationFrame(loop); }); }; requestAnimationFrame(loop); return true; }
function runZxing() { setStatus("{% translate 'Loading scanner library...' %}"); return import("https://cdn.jsdelivr.net/npm/@zxing/browser@0.1.5/+esm").then(function (mod) { var reader = new mod.BrowserMultiFormatReader(); setStatus("{% translate 'Scanning...' %}"); return reader.decodeFromVideoElement(video, function (result, err, controls) { if (result) { var text = result.getText(); if (isValidBookCode(text)) { if (controls) controls.stop(); redirect(text); } } }); }).catch(function () { setStatus("{% translate 'Could not load scanner. Use manual entry below.' %}"); }); }
startCamera().then(function () { if (!runNativeDetector()) runZxing(); }).catch(function (err) { if (err && (err.name === "NotAllowedError" || err.name === "SecurityError")) { setStatus("{% translate 'Camera permission denied. Use manual entry below.' %}"); } else if (err && err.name === "NotFoundError") { setStatus("{% translate 'No camera found. Use manual entry below.' %}"); } else { setStatus("{% translate 'Camera unavailable. Use manual entry below.' %}"); } });
window.addEventListener("pagehide", stopStream);
})();
```

--------------------------------

### Initialize and Sort Profile Layout Data

Source: https://github.com/neodb-social/neodb/blob/main/journal/templates/profile.html

Parses layout data from JSON and applies visibility settings to elements. It then sorts elements into a designated container.

```javascript
const initialLayoutData = JSON.parse(document.getElementById('layout-data').textContent);
initialLayoutData.forEach(elem => {
    $('#' + elem.id).data('visibility', elem.visibility);
    if (!elem.visibility) {
        $('#' + elem.id).hide();
    }
    $('#' + elem.id).appendTo('.sortable');
});
$('.unsorted .entity-sort').each((i, elem) => {
    $('.sortable').append(elem);
});
```

--------------------------------

### Account Migration Links

Source: https://github.com/neodb-social/neodb/blob/main/users/templates/users/account.html

Links for migrating an account to or from the current instance. It's recommended to link an email to your account before migrating.

```HTML
[{% trans "Migrate another account here" %}]({% url 'users:migrate_in' %})
```

```HTML
[{% trans "Migrate to another account" %}]({% url 'users:migrate_out' %})
```

--------------------------------

### Initialize Multi-Select Widget

Source: https://github.com/neodb-social/neodb/blob/main/common/templates/widgets/multi_select.html

Configure the multi-select widget with various options. Use `selectAll: false` to disable the 'select all' feature. Set `width` to '100%' for full container width. `displayTitle: true` shows the title, and `minimumCountSelected` can be set to a high number to effectively disable it if needed. `filter: true` enables a search input for options.

```javascript
$"select\[name=\\"{{ widget.name }}\\"\"\]".multipleSelect({
  selectAll: false,
  width: "100%",
  displayTitle: true,
  // any value greater than number of genres
  minimumCountSelected: 50,
  filter: true,
})
```