Baserow consists of two main components:
The backend consists of the core, api and database apps. The package also contains base settings that can be extended. The REST API is written as a decoupled component which is not required to run Baserow. It is highly recommended though. The same goes for the database app, which is written as a plugin for Baserow. Without it you would only have the core which has functionality like authentication, workspaces and the application abstraction.
If you look at the code of the API views you will notice that they use classes like CoreHandler, TableHandler, FieldHandler etc. The API views are actually a REST API shell around these handlers which are doing the actual job. The reason why we choose to do it this way is that if we ever want to implement a Web Socket API, SOAP API or any other API we can also build that around the same handler. That way we never have to write code twice. It is also useful for when you want to do something via the command line. If you for example want to create a new workspace you can do the following.
from django.contrib.auth import get_user_model from baserow.core.handler import CoreHandler User = get_user_model() user = User.objects.get(pk=1) workspace = CoreHandler().create_workspace(user, name='Example workspace')
The web-frontend consists of the core and database modules. The package also contains some base config that can be extended. It is basically a user-friendly shell around the backend that can run in your browser. It is made using NuxtJS.
A workspace can contain multiple applications. It can be used to define a company, and it is
possible to invite additional users to a workspace. Every user in the workspace has access to
all the applications within that workspace. Live collaboration allows users to immediately
see changes made by others without having to refresh the page. Workspaces can easily be
created, edited and deleted via the
and via the REST API.
An application is more of an abstraction that can be added to a workspace. By default the
database plugin is included which contains the database application. Via the
“create new” button in the sidebar a new application instance can be created for the
selected workspace. When clicked you will see a context menu with all the application types.
Plugins can introduce new application types. Applications can easily be created, edited
and deleted via the
baserow.core.handler.CoreHandler and via the REST API.
More information about the concepts of the database application can be found on the database plugin introduction page.
In combination with the default settings and config the following environment variables are accepted.
baserow): The name of the PostgreSQL database.
baserow): The username for the PostgreSQL database.
baserow): The password for the PostgreSQL database.
db): The hostname of the PostgreSQL server.
5432): The port of the PostgreSQL server.
0): Set to
1to force download links to download files via XHR query to bypass
Content-Disposition: inlinethat can’t be overridden in another way. If your files are stored under another origin, you also must add CORS headers to your server.
BASEROW_DISABLE_GOOGLE_DOCS_FILE_PREVIEW(default ``): Set to
1to disable Google docs file preview in the web-frontend.
http://localhost:8000): The publicly accessible URL of the backend. For the development environment this is
http://localhost:8000, but if you change the port to 9000 it will be
http://localhost:9000. You should be able to lookup this url with your browser.
http://backend:8000): Not only the browser, but also the web-frontend server should be able to make HTTP requests to the backend. It might not have access to the
PUBLIC_BACKEND_URLor there could be a more direct route, (e.g. from container to container instead of via the internet). In case of the development environment the backend container be accessed via the
backendhostname and because the server is also running on port 8000 inside the container, the private backend URL should be
http://localhost:3000): The publicly accessible URL of the web-frontend. For the development environment this is
http://localhost:3000, but again you can change the port to whatever you wish. This url is reachable with your browser.
no-reply@localhost): The ‘from’ email address of the emails that the platform sends. Like when a user requests a password recovery.
INITIAL_TABLE_DATA_LIMIT(default not set): Indicates the initial table data limit. If for example 100 is provided then it will not be possible to import a CSV file with more than 100 rows.
redis): The hostname of the Redis server.
6379): The port of the Redis server.
REDIS_USER(default ``): The username of the Redis server.
REDIS_PASSWORD(default ``): The password of the Redis server.
redis): The redis protocol. Can either be
EMAIL_SMTP(default ``): Providing anything other than an empty string will enable SMTP email.
localhost): The hostname of the SMTP server.
EMAIL_SMTP_USE_TLS(default ``): Providing anything other than an empty string will enable connecting to the SMTP server via TLS.
EMAIL_SMTP_USE_TLSfrom above was initially wrongly spelled as
EMAIL_SMPT_USE_TLS. This issue has since been addressed in #247. However,
EMAIL_SMPT_USE_TLSis still supported for those who might still be using it in their environment. It’s highly recommended you use the correct var name if working with the latest version as this support might be removed in the future.
25): The port of the SMTP server.
EMAIL_SMTP_USER(default ``): The username for the SMTP server.
EMAIL_SMTP_PASSWORD(default ``): The password of the SMTP server.
HOURS_UNTIL_TRASH_PERMANENTLY_DELETED(default 72): The number of hours to keep trashed items until they are permanently deleted.
BASEROW_MAX_IMPORT_FILE_SIZE_MB(default 512Mb): The maximum file size allowed to be imported in megabytes.
DISABLE_ANONYMOUS_PUBLIC_VIEW_WS_CONNECTIONS(default ``): If set to ‘true’ will disable realtime events being sent to publicly shared views.