services/fdroid-docker-reposerver
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Daniele Viti
2023-09-12 21:13:30 +02:00
committed by GitHub
parent a7e1e2c852
commit b6271ac537
1 changed files with 1 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -10,28 +10,20 @@ This Dockerfile creates a Docker image that deploys an F-Droid repository server
The Dockerfile consists of two stages: 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. 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. 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 ## Usage
1. Create a .env file specifying the Timezone (E.g. TZ=Europe/Rome) 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. 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. 3. Create a `users.json` file with the desired user credentials and permissions.
4. Place your custom apps (APK files) in the `/repo` directory. 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 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) 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. 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`. 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) 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 ## Customization