59 lines
4.1 KiB
Markdown
59 lines
4.1 KiB
Markdown
# F-Droid Repo Server with Filebrowser
|
|
|
|
Docker Hub Pre-Built image: [fdroid-reposerver](https://hub.docker.com/r/dnviti/fdroid-reposerver)
|
|
You can also use the `docker-compose-deploy.yaml` from here to automate the process.
|
|
|
|
This Dockerfile creates a Docker image that deploys an F-Droid repository server using Alpine Linux and serves the `/repo` directory using Filebrowser with authentication.
|
|
|
|
## Overview
|
|
|
|
The Dockerfile consists of two stages:
|
|
|
|
1. **Build stage**: In this stage, the F-Droid repository is built using Alpine Linux. The necessary packages and tools for the F-Droid server and Android SDK are installed, and the F-Droid repository is initialized and updated.
|
|
2. **Filebrowser stage**: In this stage, the `/repo` directory from the build stage is served using Filebrowser with authentication. The `settings.json` file is used to configure Filebrowser, and the authentication is handled using a `users.json` file.
|
|
|
|
## Usage
|
|
|
|
1. Create a .env file specifying the Timezone (E.g. TZ=Europe/Rome)
|
|
2. Create a `settings.json` file with the desired Filebrowser settings, including the authentication method and the path to the `users.json` file.
|
|
3. Create a `users.json` file with the desired user credentials and permissions.
|
|
4. Place your custom apps (APK files) in the `/repo` directory.
|
|
5. Build the Docker image using the provided Dockerfile: `docker build -t fdroid-repo-server .` (you can also use `docker compose build` to use the default settings
|
|
6. Run a container using the built image: `docker run -d -p 80:80 --name fdroid-repo-server fdroid-repo-server` (or use `docker compose -f docker-compose-deploy.yaml up -d` to deploy with default settings)
|
|
7. Access the Filebrowser web interface at `http://<your-server-ip>:8083` (or the appropriate IP address) and log in with the credentials specified in the `users.json` file.
|
|
8. Share the F-Droid repository URL with your users. The URL to add to the repository list in F-Droid app should be in the format `http://<your-server-ip>:8084/repo`.
|
|
9. Default username and password is admin/admin (please change the password at first configuration)
|
|
10. A standard single node production configuration would be behind a reverse proxy (the one like [Nginx Proxy Manager](https://nginxproxymanager.com/))
|
|
|
|
## Customization
|
|
|
|
You can modify the Dockerfile and the `settings.json` and `users.json` files according to your specific requirements. For more information on Filebrowser settings and authentication methods, refer to the [Filebrowser documentation](https://filebrowser.org/configuration/authentication-method).
|
|
|
|
You can use a custom Keystore, to do so you'll have to generate your own:
|
|
- On Windows you can use **keytool**
|
|
1. `keytool -genkey -v -keystore keystore_name.p12 -alias keystore_alias -keyalg RSA -keysize 2048 -storetype pkcs12 -validity 10000`
|
|
1. If you are using Visual Studio and Xamarin or MAUI you have to provide a keystore in a .keystore format, to convert the .p12 to .keystore run the following command `keytool -importkeystore -srckeystore keystore_name.p12 -srcstoretype PKCS12 -destkeystore keystore_name.keystore -deststoretype JKS`
|
|
- On Linux you can use **openssl**
|
|
1. `openssl genrsa -out myKey.pem 2048`
|
|
1. `openssl req -new -key myKey.pem -out cert.csr`
|
|
1. `openssl x509 -req -days 365 -in cert.csr -signkey myKey.pem -out myCert.pem`
|
|
1. `openssl pkcs12 -export -out keystore.p12 -inkey myKey.pem -in myCert.pem`
|
|
- Then upload the new keystore to the /fdroid folder and edit the config.yml accordingly
|
|
- If you upload a new app signed using the generated keystore then it will be available for download from F-Droid app
|
|
|
|
## Versioning
|
|
|
|
To enable automatic updates managed by F-Droid app you need to specify VersionName(string) and VersionCode(uint).
|
|
|
|
In case the app has been built using Xamarin or MAUI you'll need to specify the options below in your current .csproj file:
|
|
```xml
|
|
<ApplicationDisplayVersion>1.0.0</ApplicationDisplayVersion>
|
|
<ApplicationVersion>1</ApplicationVersion>
|
|
```
|
|
|
|
|
|
## Credits
|
|
|
|
- [FileBrowser](https://github.com/filebrowser) for his amazing work, more details at [filebrowser.org](https://filebrowser.org/)
|
|
- [F-Droid](https://f-droid.org/it/) for the amazing open source repo app store
|