====== flatnotes ======

[[informatica:software:aplicaciones_web|Aplicación web]] para tomar notas. Guarda todo en ficheros [[informatica:markdown|Markdown]] y no emplea base de datos. Programado en [[..:..:programacion:python|Python]] para el //backend//.

  * [[https://github.com/dullage/flatnotes|Repositorio de código]]
  * [[https://demo.flatnotes.io/|Instancia de demostración]]
  * [[https://adam.dullage.com/posts/flatnotes/|Anuncio de flatnotes por su autor]]

{{ https://adam.dullage.com/posts/flatnotes/search-box.png |}}
===== Instalación =====

==== Docker ====

Ejemplo de ''docker-compose.yml'':

<code yaml>
--
version: "3"

services:
  flatnotes:
    container_name: flatnotes
    image: dullage/flatnotes:latest
    environment:
      PUID: 1000
      GUID: 1000
      FLATNOTES_AUTH_TYPE: "password"
      FLATNOTES_USERNAME: "TempWin"
      FLATNOTES_PASSWORD: "cambiame"
      FLATNOTES_SECRET_KEY: "aLongRandomSeriesOfCharacters"
    volumes:
      - "./data:/data"
      # Optional. Allows you to save the search index in a different location:
      # - "./index:/data/.flatnotes"
    ports:
      - "8080:8080"
    restart: unless-stopped
</code>

===== Características =====

  * Diseño adaptable
  * Editor con modo texto (soporte [[informatica:markdown|Markdown]]) y WYSIWYG
  * Buscador avanzado.
  * Soporte de etiquetas (//tags//)
  * Temas claro y oscuro
  * Varias opcione de autenticación (ninguna, solo lectura, usuario / contraseña y 2FA)
  * API
  * Sin base de datos.

===== Uso =====

==== Tipos de autenticación ====

Actualmente, **flatnotes** soporta 4 tipos:

  * //None//: **flatnotes** está abierto a cualquier con acceso.
  * //Read Only//: parecido al anterior, pero la creación, modificación y eliminación está deshabilitada. Útil si quieres usar **flatnotes** como blog o para documentación.
  * //Password//: el acceso a **flatnotes** está protegido por usuario y contraseña.
  * //TOTP//: además de usuario y contraseña, **flatnotes** está también protegido por contraseña temporal de un solo uso (//Time-based one-time-password//)

Estas opciones se pueden indicar en las [[https://github.com/Dullage/flatnotes/wiki/Environment-Variables|variables de entorno]]

==== Edición de notas fuera de flatnotes ====

Es posible crear o editar ficheros en la carpeta que hayamos configurado en **flatnotes**. Los cambios luego se verán en la aplicación web.

Por ejemplo, si hemos desplegado **flatnotes** con Docker Compose, tendremos creado el directorio ''data'' donde se irán guardando todas las notas que vayamos creando como ficheros de texto plano con sintaxis Markdown (''hola.md'', por ejemplo).

Si creamos nuevos ficheros en ese directorio, estarán luego accesibles desde la aplicación web para que podamos verlos o editarlos.