An open API service indexing awesome lists of open source software.

https://github.com/lovedolove/alist-freebsd

This repository provides a build wrapper and automation for compiling the upstream alist project for FreeBSD. It includes a custom build.sh script and GitHub Actions workflows to automate building and cleaning up workflow runs. The resulting binary is suitable for running on FreeBSD systems.
https://github.com/lovedolove/alist-freebsd

alist automation binary build-script ci-cd cloud-storage deprecated file-management freebsd github-actions go webdav

Last synced: 7 days ago
JSON representation

This repository provides a build wrapper and automation for compiling the upstream alist project for FreeBSD. It includes a custom build.sh script and GitHub Actions workflows to automate building and cleaning up workflow runs. The resulting binary is suitable for running on FreeBSD systems.

Awesome Lists containing this project

README

          

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![License][license-shield]][license-url]





Logo

alist-freebsd


FreeBSD build wrapper for the upstream alist project.


Explore the docs »




Report Bug
·
Request Feature


Table of Contents


  1. About The Project

  2. Built With

  3. Getting Started

  4. Usage

  5. Roadmap

  6. Contributing

  7. License

  8. Contact

  9. Acknowledgments

## About The Project

This repository provides a build wrapper and automation for compiling the upstream [alist](https://github.com/alist-org/alist) project for FreeBSD. It includes a custom `build.sh` script and GitHub Actions workflows to automate building and cleaning up workflow runs. The resulting binary is suitable for running on FreeBSD systems.

(back to top)

### Built With

- [Go](https://golang.org/)
- [FreeBSD](https://www.freebsd.org/)
- [alist](https://github.com/alist-org/alist)
- [alist-web](https://github.com/alist-org/alist-web)

(back to top)

## Getting Started

To build and run alist for FreeBSD, follow these steps.

### Prerequisites

- Go (latest version recommended)
- clang with FreeBSD cross-compilation support
- FreeBSD sysroot (the build script downloads this automatically)
- wget, git, bash

### Installation

1. Clone this repository:
```sh
git clone https://github.com/LoveDoLove/alist-freebsd.git
cd alist-freebsd
```
2. Run the build script:
```sh
bash build.sh
```
This will download the latest upstream alist and alist-web, set up the FreeBSD environment, and build the binary.

(back to top)

## Usage

After building, the `alist` binary will be available in the project directory. Transfer it to your FreeBSD system and run as you would the upstream alist binary. For configuration and usage, see the [alist documentation](https://github.com/alist-org/alist#readme).

(back to top)

## Contributing

Contributions are welcome! Please use the provided issue templates for bug reports and feature requests. Fork the repo, create a feature branch, and submit a pull request.

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

(back to top)

### Top contributors:


contrib.rocks image

## License

Distributed under the MIT License. See `LICENSE` for more information.

(back to top)

## Contact

LoveDoLove - [GitHub](https://github.com/LoveDoLove)

Project Link: [https://github.com/LoveDoLove/alist-freebsd](https://github.com/LoveDoLove/alist-freebsd)

(back to top)

## Sponsorship

This project is proudly supported by [ZMTO](https://www.zmto.com) as part of their open-source VPS program. We extend our sincere gratitude to ZMTO for their valuable resources and commitment to empowering open-source innovation.

(back to top)

## Acknowledgments

- [alist](https://github.com/alist-org/alist)
- [alist-web](https://github.com/alist-org/alist-web)
- [Best-README-Template](https://github.com/othneildrew/Best-README-Template)

(back to top)

[contributors-shield]: https://img.shields.io/github/contributors/LoveDoLove/alist-freebsd.svg?style=for-the-badge
[contributors-url]: https://github.com/LoveDoLove/alist-freebsd/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/LoveDoLove/alist-freebsd.svg?style=for-the-badge
[forks-url]: https://github.com/LoveDoLove/alist-freebsd/network/members
[stars-shield]: https://img.shields.io/github/stars/LoveDoLove/alist-freebsd.svg?style=for-the-badge
[stars-url]: https://github.com/LoveDoLove/alist-freebsd/stargazers
[issues-shield]: https://img.shields.io/github/issues/LoveDoLove/alist-freebsd.svg?style=for-the-badge
[issues-url]: https://github.com/LoveDoLove/alist-freebsd/issues
[license-shield]: https://img.shields.io/github/license/LoveDoLove/alist-freebsd.svg?style=for-the-badge
[license-url]: https://github.com/LoveDoLove/alist-freebsd/blob/main/LICENSE