Add a Textarea custom field type

[hiddenman]

NetBox version

v2.11.8

Feature type

Data model extension

Proposed functionality

Add a Textarea custom field type

Use case

Currently it's not possible to add a multi-line custom field. Only single line text field is supported.

It's often required to add some notes or comments to a particular cable/port/whatever.
For example, our cables have multi-line stickers like:

dsp-fg-1  mgmt2
dsp-fg-2  mgmt2

and there is no way to store them with a proper formatting.

Database changes

No response

External dependencies

No response

[jeremystretch]

Given your example, it seems like raw JSON support might be more suitable for your use case.

[hiddenman]

Given your example, it seems like raw JSON support might be more suitable for your use case.

Hi,

In this case it might be enough. What about other descriptions/notes?
I've checked Django supported types, models.TextField() is suitable there, isn't it?

[hiddenman]

And i can't find any kind of JSON field type in the Django docs, can you?

[jeremystretch]

NetBox does not employ Django model fields for custom fields. Custom field data is stored as JSON in the custom_field_data field on each model. If you'd like to become more familiar with how custom fields work, please review the code here and here (and probably some other places I can't think of).

Because all custom field data is stored as JSON, we have a lot of flexibility over what to store. However, we also need to be wary of overdeveloping the custom fields feature into a sort of mini NoSQL database.

[hiddenman]

NetBox does not employ Django model fields for custom fields. Custom field data is stored as JSON in the custom_field_data field on each model. If you'd like to become more familiar with how custom fields work, please review the code here and here (and probably some other places I can't think of).

Because all custom field data is stored as JSON, we have a lot of flexibility over what to store. However, we also need to be wary of overdeveloping the custom fields feature into a sort of mini NoSQL database.

Ok, thank you. As far as i understand you can just add/allow JSONField() as custom field type?
I was looking through the code to understand how it works and thought it was related to the Django model.

[sleepinggenius2]

I just wanted to second the textarea custom field type. It would be really nice to also allow for it to support markdown rendering (could be an option). We are looking to break out site data for things like driving directions and access information, so that they can be updated easily without clobbering other data in the comments field, as well as being displayed consistently for field technicians. It would be really helpful to have markdown support there to add things like links, lists, and tables.

[hiddenman]

Hi,

I'm filling a new feature request to the secretstore plugin and just realized that it requires a textarea customfield to be implemented.
I want to store ssh private keys, SSL certificates keys and so on.

Right now, when i save my private key it becomes broken and messed after saving.

So it would be really great to have something like textarea/JSON.

[geor-g]

Hi,

I'm filling a new feature request to the secretstore plugin and just realized that it requires a textarea customfield to be implemented.
I want to store ssh private keys, SSL certificates keys and so on.

Right now, when i save my private key it becomes broken and messed after saving.

So it would be really great to have something like textarea/JSON.

@hiddenman As a workaround, you could encode it, for example via base64.

[jeremystretch]

I think it makes sense to add a new longtext custom field type for free-form text. This would render as a <textarea> HTML form widget, and would support Markdown rendering similar to comments. I'm going to mark this as needs milestone with the assumption that this approach satisfies the proposal.

Separately, I've opened #7452 to discuss adding a JSON custom field type.