Penpot/penpot
0
Fork 0
mirror of https://github.com/penpot/penpot.git synced 2025-01-08 16:00:19 -05:00
Code Issues Activity
penpot/README.md
mathieu.brunot 8b796f12da
📝 Update documentation regarding docker env
2019-02-17 15:35:28 +01:00

3.6 KiB
Raw Blame History

License: MPL-2.0 Build Status Docker Automated buid Docker Pulls

UXBOX

UXBOX

Introduction

The open-source solution for design and prototyping. UXBOX is currently at an early development stage but we are working hard to bring you the beta version as soon as possible. Follow the project progress in Twitter or Github and stay tuned!

See SVG specification

SVG based

UXBOX works with SVG, a standard format, for all your designs and prototypes . This means that all your stuff in UXBOX is portable and editable in many other vector tools and easy to use on the web.

Docker

Persistent data

The UXBOX installation and all data are stored in the database (file uploads, etc). The docker daemon will store that data within the docker directory /var/lib/docker/volumes/.... That means your data is saved even if the container crashes, is stopped or deleted.

To make your data persistent to upgrading and get access for backups is using named docker volume or mount a host folder. To achieve this you need one volume for your database container.

Database:

  • /var/lib/mysql MySQL / MariaDB Data
  • /var/lib/postgresql/data PostgreSQL Data
$ docker run -d \
    -v db:/var/lib/postgresql/data \
    postgresql

Auto configuration via environment variables

The following environment variables are also honored for configuring your UXBOX instance:

Frontend

Backend

  • -e UXBOX_HTTP_SERVER_DEBUG=... (defaults to false)
  • -e UXBOX_DATABASE_USERNAME="..." (defaults to uxbox)
  • -e UXBOX_DATABASE_PASSWORD="..." (defaults to youshouldoverwritethiswithsomethingelse)
  • -e UXBOX_DATABASE_NAME="..." (defaults to uxbox)
  • -e UXBOX_DATABASE_SERVER="..." (defaults to localhost)
  • -e UXBOX_DATABASE_PORT=... (defaults to 5432)
  • -e UXBOX_EMAIL_REPLY_TO="..." (defaults to no-reply@uxbox.io)
  • -e UXBOX_EMAIL_FROM="..." (defaults to no-reply@uxbox.io)
  • -e UXBOX_SMTP_HOST="..." (defaults to localhost)
  • -e UXBOX_SMTP_PORT=... (defaults to 25)
  • -e UXBOX_SMTP_USER="..." (defaults to uxbox)
  • -e UXBOX_SMTP_PASSWORD="..." (defaults to youshouldoverwritethiswithsomethingelse)
  • -e UXBOX_SMTP_SSL=... (defaults to false)
  • -e UXBOX_SMTP_TLS=... (defaults to false)
  • -e UXBOX_SMTP_ENABLED=... (defaults to false)
  • -e UXBOX_SECRET="..." (defaults to youshouldoverwritethiswithsomethingelse)

Important note: make sure to use quotation marks for string variables or the backend might try to interpret the values as symbols and have weird issues.

Contributing

Open to you!

We love the open source software community. Contributing is our passion and because of this, we'll be glad if you want to participate and improve UXBOX. All your awesome ideas and code are welcome!

Please refer to the Contributing Guide

License

This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/.