Pixelfed#

Pixelfed is a free and ethical photo sharing platform, powered by ActivityPub federation.

amd64
arm64
armv7

Information#

Docker Image: !!! LINK TO DOCKER IMAGE/ DOCKER HUB !!!
Current Image Version: v0.10.9

SETUP#

Enabling pixelfed#

Command:#

vlab set pixelfed.enable True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

pixelfed
enable: True

Finalising changes:#

run: vlab update_one service=pixelfed

FIRST RUN#

!!! DEVELOPERS: make sure that you include any information that the user requires to get started, below. !!!
!!! Below are some examples with headings, and with some example instructions !!!

Environment variables#

Adjust the environment variables (roles/pixelfed/templates/pixelfed.env.j2) to match your needs.

More information about the possible options are available here: Pixelfed Configuration

Setup#

This once requires some manual setup, unfortunately.

  • Connect to the server with ssh
  • As soon as the db and the app started completely run docker exec pixelfed_pixelfed_1 gosu www-data:www-data php artisan migrate --force. This will do the database migrations.
    • Note: When you start the service for the first time, the mariadb container needs to do some initial configuration and thus needs a bit longer to start completely.
  • Now the configuration is complete and the service is available

Post Install work#

You'll want to create a user, and import city data. To do that ssh to your server and execute these commands

  • `docker exec pixelfed_pixelfed_1 /bin/bash' - This will give you a shell to run the following commands
  • php artisan user:create - follow the prompts, ensure it's an admin user
  • `php artisan import:cities'
  • 'exit' - To exit the docker shell

SMTP/ MAIL#

  1. run vlab decrypt to decrypt the vault.yml file
  2. make some changes

SMTP Settings#

smtp:
host:
port:
user:
pass:
from_email:
from_name:
  1. run vlab update_one service=pixelfed to complete the changes

ACCESS#

pixelfed (HTTPS) link: https://pixelfed.vivumlab.xyz/ pixelfed (HTTP) link: http://pixelfed.vivumlab.xyz/

OPTIONS#

HTTPS_ONLY#

Default: False
Options: True/False

Command:#

vlab set pixelfed.https_only True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

pixelfed
https_only: True
Finalising changes:#

run: vlab update_one service=pixelfed

AUTH#

Default: False
Options: True/False

Command:#

vlab set pixelfed.auth True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

pixelfed
auth: True
Finalising changes:#

run: vlab update_one service=pixelfed

DOMAIN#

Default: False
NOTE: include the sitename and top level domain suffix. eg. name.com, site.net

Command:#

vlab set pixelfed.domain pixelfed.com

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

pixelfed
domain: pixelfed.com
Finalising changes:#

run: vlab update_one service=pixelfed

SUBDOMAIN#

Default: pixelfed
NOTE: Periods/ delimiters are not required. eg. 'media' will set the full URL as 'media.vivumlab.xyz'

Command:#

vlab set pixelfed.subdomain media

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

pixelfed
subdomain: media
Finalising changes:#

run: vlab update_one service=pixelfed

VERSION#

Default: v0.10.9
NOTE: Ensure that the version exists

Command:#

vlab set pixelfed.version 2.7

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

pixelfed
version: 2.7
Finalising changes:#

run: vlab update_one service=pixelfed

Need more help?#

Further information regarding services can be found.
General Information can be found in the documentation.
Additional assistance can be found on our Contact Us page.