ric/docker-mastodon-bird-ui
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Working version with added README.md and screenshots

Browse source
This commit is contained in:
Ric Harvey 2024-06-17 22:21:48 +01:00
parent 9a58fed4eb
commit 9ec10e2df1
Signed by: ric
GPG key ID: CD63CE502B962F16
4 changed files with 163 additions and 67 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

220
README.md
View file

@ -1,93 +1,189 @@
# docker-mastodon-bird-ui
This repo is used to build the latest docker image for mastodon and include the awesome theme by [@rolle](https://awscommunity.social/@rolle@mementomori.social) (be sure to give them a follow) called Bird-UI which makes mastodon feel like the long gone, good old days of twitter. You can find all the details of this theme here: [GitHub](https://github.com/ronilaukkarinen/mastodon-bird-ui)
It uses the default docker image directly from [mastodon](https://github.com/mastodon/mastodon) only modified by the instructions from @rolle.
![The Bird UI Theme](./img/full.png)
## Getting started
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
### Building the image yourself
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
First check out this repository and pull the submodule in git:
## Add your files
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
```
cd existing_repo
git remote add origin https://gitlab.com/ric_harvey/docker-mastodon-bird-ui.git
git branch -M main
git push -uf origin main
```bash
git clone https://gitlab.com/ric_harvey/docker-mastodon-bird-ui.git
git submodule update --init --recursive
```
## Integrate with your tools
You should then edit the build.sh file and replace ```--tag richarvey/mastodon-bird-ui:$mastodon_version --tag richarvey/mastodon-bird-ui:latest``` with the details of your own docker repository. Then you just need to run:
- [ ] [Set up project integrations](https://gitlab.com/ric_harvey/docker-mastodon-bird-ui/-/settings/integrations)
```bash
./bash
```
## Collaborate with your team
This script will download the theme and patch the locales file to display the options for choice, then build and push the docker images to your own repo.
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
### Pulling from docker
## Test and Deploy
You can pull directly from docker hub with the following command:
Use the built-in continuous integration in GitLab.
```bash
docker pull richarvey/mastodon-bird-ui:latest
```
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
Starting with v4.2.9 of mastodon you can also pull by a specific tag version:
***
```bash
docker pull richarvey/mastodon-bird-ui:v4.2.9
```
# Editing this README
### Running in docker compose
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
If you want to use the official docker compose method for running mastodon here is the modified code for **compose.yml**:
## Suggestions for a good README
```yaml
# This file is designed for production server deployment, not local development work
# For a containerized local dev environment, see: https://github.com/mastodon/mastodon/blob/main/README.md#docker
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
services:
db:
restart: always
image: postgres:14-alpine
shm_size: 256mb
networks:
- internal_network
healthcheck:
test: ['CMD', 'pg_isready', '-U', 'postgres']
volumes:
- ./postgres14:/var/lib/postgresql/data
environment:
- 'POSTGRES_HOST_AUTH_METHOD=trust'
## Name
Choose a self-explaining name for your project.
redis:
restart: always
image: redis:7-alpine
networks:
- internal_network
healthcheck:
test: ['CMD', 'redis-cli', 'ping']
volumes:
- ./redis:/data
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
# es:
# restart: always
# image: docker.elastic.co/elasticsearch/elasticsearch:7.17.4
# environment:
# - "ES_JAVA_OPTS=-Xms512m -Xmx512m -Des.enforce.bootstrap.checks=true"
# - "xpack.license.self_generated.type=basic"
# - "xpack.security.enabled=false"
# - "xpack.watcher.enabled=false"
# - "xpack.graph.enabled=false"
# - "xpack.ml.enabled=false"
# - "bootstrap.memory_lock=true"
# - "cluster.name=es-mastodon"
# - "discovery.type=single-node"
# - "thread_pool.write.queue_size=1000"
# networks:
# - external_network
# - internal_network
# healthcheck:
# test: ["CMD-SHELL", "curl --silent --fail localhost:9200/_cluster/health || exit 1"]
# volumes:
# - ./elasticsearch:/usr/share/elasticsearch/data
# ulimits:
# memlock:
# soft: -1
# hard: -1
# nofile:
# soft: 65536
# hard: 65536
# ports:
# - '127.0.0.1:9200:9200'
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
web:
build: .
image: ghcr.io/mastodon/mastodon:v4.2.9
restart: always
env_file: .env.production
command: bundle exec puma -C config/puma.rb
networks:
- external_network
- internal_network
healthcheck:
# prettier-ignore
test: ['CMD-SHELL', 'wget -q --spider --proxy=off localhost:3000/health || exit 1']
ports:
- '127.0.0.1:3000:3000'
depends_on:
- db
- redis
# - es
volumes:
- ./public/system:/mastodon/public/system
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
streaming:
build: .
image: ghcr.io/mastodon/mastodon:v4.2.9
restart: always
env_file: .env.production
command: node ./streaming
networks:
- external_network
- internal_network
healthcheck:
# prettier-ignore
test: ['CMD-SHELL', 'wget -q --spider --proxy=off localhost:4000/api/v1/streaming/health || exit 1']
ports:
- '127.0.0.1:4000:4000'
depends_on:
- db
- redis
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
sidekiq:
build: .
image: ghcr.io/mastodon/mastodon:v4.2.9
restart: always
env_file: .env.production
command: bundle exec sidekiq
depends_on:
- db
- redis
networks:
- external_network
- internal_network
volumes:
- ./public/system:/mastodon/public/system
healthcheck:
test: ['CMD-SHELL', "ps aux | grep '[s]idekiq\ 6' || false"]
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Uncomment to enable federation with tor instances along with adding the following ENV variables
## http_hidden_proxy=http://privoxy:8118
## ALLOW_ACCESS_TO_HIDDEN_SERVICE=true
# tor:
# image: sirboops/tor
# networks:
# - external_network
# - internal_network
#
# privoxy:
# image: sirboops/privoxy
# volumes:
# - ./priv-config:/opt/config
# networks:
# - external_network
# - internal_network
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
networks:
external_network:
internal_network:
internal: true
```
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
## Help needed
So far the English and Finish locales are patched so the theme appears in the preferences section under "Appearance". If you can provide a new translation in the *patches* directory for another language that would be most appreciated please submit a merge/pull request.
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
![Screenshot of the preferences/appearances screen](./img/preferences.png)
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
## License
For open source projects, say how it is licensed.
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
> There's no need to generate the diff file as ```build.sh``` generates these for you.

10
build.sh
View file

@ -47,13 +47,13 @@ echo -e "default: styles/mastodon-bird-ui-dark.scss\nmastodon-bird-ui-light: sty
# Patch the locales this will loop thtough more as we add them
for i in `ls ../diffs/` ; do patch -N config/locales/"${i/diff/yml}" < ../diffs/$i ; done
# Build the images for multiple architectures
docker buildx build --platform linux/amd64,linux/arm64 --push -t richarvey/mastodon-bird-ui:$mastodon_version .
# If the main branch of the repo build tagged version and latest image
cd ../
BRANCH="$(git rev-parse --abbrev-ref HEAD)"
if [[ "$BRANCH" == "main" ]]; then
echo 'main branch';
echo 'Main branch';
# Build the images for multiple architectures
docker buildx build --platform linux/amd64,linux/arm64 --push --tag richarvey/mastodon-bird-ui:$mastodon_version --tag richarvey/mastodon-bird-ui .
cd mastodon
docker buildx build --platform linux/amd64,linux/arm64 --push --tag richarvey/mastodon-bird-ui:$mastodon_version --tag richarvey/mastodon-bird-ui:latest . ;
fi

BIN
img/full.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 249 KiB

BIN
img/preferences.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 73 KiB