README
¶
Flamenco
This repository contains the sources for Flamenco. The Manager, Worker, and Blender add-on sources are all combined in this one repository.
The documentation is available on https://flamenco.blender.org/, including instructions on how to set up a development environment & build Flamenco for the first time.
To access the documentation offline, go to the web/project-website/content
directory here in the source files.
License
Flamenco is licensed under the GPLv3+ license.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
internal
|
|
|
find_ffmpeg
package find_ffmpeg can find an FFmpeg binary on the system.
|
package find_ffmpeg can find an FFmpeg binary on the system. |
|
manager/api_impl
Package api_impl implements the OpenAPI API from pkg/api/flamenco-openapi.yaml.
|
Package api_impl implements the OpenAPI API from pkg/api/flamenco-openapi.yaml. |
|
manager/api_impl/dummy
Package dummy contains non-functional implementations of certain interfaces.
|
Package dummy contains non-functional implementations of certain interfaces. |
|
manager/api_impl/mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
manager/farmstatus
package farmstatus provides a status indicator for the entire Flamenco farm.
|
package farmstatus provides a status indicator for the entire Flamenco farm. |
|
manager/farmstatus/mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
manager/job_compilers
Package job_compilers contains functionality to convert a Flamenco job definition into concrete tasks and commands to execute by Workers.
|
Package job_compilers contains functionality to convert a Flamenco job definition into concrete tasks and commands to execute by Workers. |
|
manager/job_deleter
package job_deleter has functionality to delete jobs.
|
package job_deleter has functionality to delete jobs. |
|
manager/job_deleter/mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
manager/persistence
Package persistence provides the database interface for Flamenco Manager.
|
Package persistence provides the database interface for Flamenco Manager. |
|
manager/sleep_scheduler/mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
manager/task_logs/mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
manager/task_state_machine/mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
manager/timeout_checker/mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
own_url
Package own_url provides a way for a process to find a URL on which it can be reached.
|
Package own_url provides a way for a process to find a URL on which it can be reached. |
|
upnp_ssdp
package upnp_ssdp allows Workers to find their Manager on the LAN.
|
package upnp_ssdp allows Workers to find their Manager on the LAN. |
|
uuid
uuid is a thin wrapper around github.com/google/uuid.
|
uuid is a thin wrapper around github.com/google/uuid. |
|
worker/mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
worker/persistence
Package persistence provides the database interface for Flamenco Manager.
|
Package persistence provides the database interface for Flamenco Manager. |
|
pkg
|
|
|
api
SPDX-License-Identifier: GPL-3.0-or-later
|
SPDX-License-Identifier: GPL-3.0-or-later |
|
crosspath
Package crosspath deals with file/directory paths in a cross-platform way.
|
Package crosspath deals with file/directory paths in a cross-platform way. |
|
moremock
Package moremock contains extra matchers for the gomock package.
|
Package moremock contains extra matchers for the gomock package. |
|
oomscore
package oomscore provides some functions to adjust the Linux out-of-memory (OOM) score, i.e.
|
package oomscore provides some functions to adjust the Linux out-of-memory (OOM) score, i.e. |
|
website
package website contains references to the Flamenco website.
|
package website contains references to the Flamenco website. |
Click to show internal directories.
Click to hide internal directories.