yu-re-ka/lix-website
0
0
Fork 0
forked from lix-project/lix-website
Code Pull requests Activity

content: hide pages we don't want available yet

Browse source
This commit is contained in:
Kate Temkin 2024-05-01 18:16:59 -06:00
parent b836267ad2
commit 60b13a744b
9 changed files with 304 additions and 239 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
TODO.md
View file

@ -5,7 +5,7 @@ TODO List
### Misc
- Move "The Team" to under community
- Add "beta" to the lix logo.
- Remove the "pending pull request" from the install page, once that's merged.
- Add social media icons below lix for mastodon/github/etc.
- Figure out where "usability" should link to.
@ -21,7 +21,7 @@ TODO List
- Replace the "lix-managed systems" graphic with an image of our logo on a screen.
- Replace the placeholders for each of the three main page "why lix" points.
## Wishlist
## After Soft Release
### Misc

4
config.yaml
View file

@ -23,6 +23,10 @@ params:
social:
twitter: "https://twitter.com/LixProject"
mastodon: "https://chaos.social/LixProject"
matrix: "https://matrix.to/#/#space:lix.system"
github: "https://github.com/lix-project"
git: "https://gix.lix.systems/lix-project"
contact:
- "General Inquiries: info@lix.systems"

151
content/add-to-config.md
View file

@ -1,153 +1,16 @@
---
title: "Switching To Lix"
description: "or: how to make your existing configruation Delicious"
description: "or: how to make your existing configuration Delicious"
date: "2024-04-27"
author: "Lix Team"
---
If you have an existing configuration on **NixOS** or **nix-darwin**, the easiest way
to switch to Lix is currently by using our provided _NixOS module_. Fortunately, this
usually means adding only a couple of lines to your configuration.
**Not yet available.**
## Flake-based Configurations
This install page is currently hidden until this website officially launches. We appreciate how excited you must be,
given you've found this site ahead of time! Thanks for your support and patience. <3
Adding Lix to a flake-based configuration is relatively simple. First, add the Lix module to your _flake inputs_:
<small><small>
_Psst! If you're in our beta and want to peek at the instructions ahead of time, they're in the git repo for this website._
</small></small>
```nix
{
inputs = {
# Add this section to your flake inputs!
#
# Note that this assumes you have a flake-input called nixpkgs,
# which is often the case. If you've named it something else,
# you'll need to change the `nixpkgs` below.
lix = {
url = "git+ssh://git@git.lix.systems/lix-project/lix";
flake = false;
};
lix-module = {
url = "git+https://git.lix.systems/lix-project/nixos-module";
inputs.lix.follows = "lix";
inputs.nixpkgs.follows = "nixpkgs";
};
}
# <rest of configuration omitted>
}
```
Next, add the `lix-module` as one of the arguments to your output function:
```nix
{
# <configuration above omitted>
# Add the `lix-module` argument to your output function, as below:
outputs = {nixpkgs, lix-module, ...}: {
# <rest of configuration omitted>
}
}
```
Finally, add the Lix _NixOS Module_ to your configuration:
```nix
{
# <configuration above omitted>
# Add the `lix-module` argument to your output function, as below:
outputs = {nixpkgs, lix-module, ...}: {
# The configuration here is an example; it will look slightly different
# based on your platform (NixOS, nix-darwin) and architecture.
nixosConfigurations.your-box = nixpkgs.lib.nixosSystem {
system = "x86_64-linux"
modules = [
# This is the important part -- add this line to your module list!
lix-module.nixosModules.default
];
};
}
# <configuration below omitted>
}
```
Rebuild and switch into your new system (either using `nixos-rebuild` or `darwin-rebuild`).
You should now be using Lix! You can verify this by asking the `nix` command to report its version:
```sh
$ nix --version
nix (Lix, like Nix) 2.90.0-lix
```
As long as you see `Lix` in the output, you're good! If you're not sure what to do now, it's a
great time to check out some of the [community's resources on Nix](/resources).
## Non-Flake Configurations
If you're not using flakes, you can set up your configuration to automatically pull down a
Lix release tarball, and then add it to your `configuration.nix`.
Open your `/etc/nixos/configuration.nix` in the editor of your choice. Find the `imports`
section, and add the line provided in the configuration
<mark>
<b>This section is currently pending on a quick update.</b>
</mark>
<br/>
<br/>
```nix
{ config, lib, pkgs, ... }:
{
imports =
[ # Include the results of the hardware scan.
./hardware-configuration.nix
# This is the core line -- it pulls down the Lix module and
# includes it in your configuration. It looks much nicer with a let
# binding -- but for clarity, we'll leave that as an exercise for the
# reader. :)
#
# Note that the tag (e.g. v2.90) in the URL here is what determines
# which version of Lix you'll wind up with.
(import
(
(fetchTarball { url = "https://git.lix.systems/lix-project/nixos-module/archive/main.tar.gz"; }) + "/module.nix"
)
{
lix = fetchTarball { url = "https://git.lix.systems/lix-project/lix/archive/main.tar.gz"; };
}
)
];
# <configuration below omitted>
}
```
Rebuild and switch into your new system (either using `nixos-rebuild` or `darwin-rebuild`).
You should now be using Lix! You can verify this by asking the `nix` command to report its version:
```sh
$ nix --version
nix (Lix, like Nix) 2.90.0-lix
```
As long as you see `Lix` in the output, you're good! If you're not sure what to do now, it's a
great time to check out some of the [community's resources on Nix](/resources).
## Having Trouble?
**One quick thing to check:** have you set `nix.package` anywhere in your configuration?
If so, your configuration option will override the Lix module. You'll want to remove it, first --
or, if you're feeling savvy, point it to the provided Lix package.
**Otherwise:** If you're having difficulty installing Lix, don't panic! Hop on over to our
[community page](/community), and check out the various ways to find help.

153
content/add-to-config_actual.md Normal file
View file

@ -0,0 +1,153 @@
---
title: "Switching To Lix"
description: "or: how to make your existing configruation Delicious"
date: "2024-04-27"
author: "Lix Team"
---
If you have an existing configuration on **NixOS** or **nix-darwin**, the easiest way
to switch to Lix is currently by using our provided _NixOS module_. Fortunately, this
usually means adding only a couple of lines to your configuration.
## Flake-based Configurations
Adding Lix to a flake-based configuration is relatively simple. First, add the Lix module to your _flake inputs_:
```nix
{
inputs = {
# Add this section to your flake inputs!
#
# Note that this assumes you have a flake-input called nixpkgs,
# which is often the case. If you've named it something else,
# you'll need to change the `nixpkgs` below.
lix = {
url = "git+ssh://git@git.lix.systems/lix-project/lix";
flake = false;
};
lix-module = {
url = "git+https://git.lix.systems/lix-project/nixos-module";
inputs.lix.follows = "lix";
inputs.nixpkgs.follows = "nixpkgs";
};
}
# <rest of configuration omitted>
}
```
Next, add the `lix-module` as one of the arguments to your output function:
```nix
{
# <configuration above omitted>
# Add the `lix-module` argument to your output function, as below:
outputs = {nixpkgs, lix-module, ...}: {
# <rest of configuration omitted>
}
}
```
Finally, add the Lix _NixOS Module_ to your configuration:
```nix
{
# <configuration above omitted>
# Add the `lix-module` argument to your output function, as below:
outputs = {nixpkgs, lix-module, ...}: {
# The configuration here is an example; it will look slightly different
# based on your platform (NixOS, nix-darwin) and architecture.
nixosConfigurations.your-box = nixpkgs.lib.nixosSystem {
system = "x86_64-linux"
modules = [
# This is the important part -- add this line to your module list!
lix-module.nixosModules.default
];
};
}
# <configuration below omitted>
}
```
Rebuild and switch into your new system (either using `nixos-rebuild` or `darwin-rebuild`).
You should now be using Lix! You can verify this by asking the `nix` command to report its version:
```sh
$ nix --version
nix (Lix, like Nix) 2.90.0-lix
```
As long as you see `Lix` in the output, you're good! If you're not sure what to do now, it's a
great time to check out some of the [community's resources on Nix](/resources).
## Non-Flake Configurations
If you're not using flakes, you can set up your configuration to automatically pull down a
Lix release tarball, and then add it to your `configuration.nix`.
Open your `/etc/nixos/configuration.nix` in the editor of your choice. Find the `imports`
section, and add the line provided in the configuration
<mark>
<b>This section is currently pending on a quick update.</b>
</mark>
<br/>
<br/>
```nix
{ config, lib, pkgs, ... }:
{
imports =
[ # Include the results of the hardware scan.
./hardware-configuration.nix
# This is the core line -- it pulls down the Lix module and
# includes it in your configuration. It looks much nicer with a let
# binding -- but for clarity, we'll leave that as an exercise for the
# reader. :)
#
# Note that the tag (e.g. v2.90) in the URL here is what determines
# which version of Lix you'll wind up with.
(import
(
(fetchTarball { url = "https://git.lix.systems/lix-project/nixos-module/archive/main.tar.gz"; }) + "/module.nix"
)
{
lix = fetchTarball { url = "https://git.lix.systems/lix-project/lix/archive/main.tar.gz"; };
}
)
];
# <configuration below omitted>
}
```
Rebuild and switch into your new system (either using `nixos-rebuild` or `darwin-rebuild`).
You should now be using Lix! You can verify this by asking the `nix` command to report its version:
```sh
$ nix --version
nix (Lix, like Nix) 2.90.0-lix
```
As long as you see `Lix` in the output, you're good! If you're not sure what to do now, it's a
great time to check out some of the [community's resources on Nix](/resources).
## Having Trouble?
**One quick thing to check:** have you set `nix.package` anywhere in your configuration?
If so, your configuration option will override the Lix module. You'll want to remove it, first --
or, if you're feeling savvy, point it to the provided Lix package.
**Otherwise:** If you're having difficulty installing Lix, don't panic! Hop on over to our
[community page](/community), and check out the various ways to find help.

15
content/community-standards.md Normal file
View file

@ -0,0 +1,15 @@
---
title: "Community Standards"
description: "making Lix a safe and productive environment <3"
date: "2024-04-27"
author: "Lix Team"
---
**Not yet available.**
This page is hidden until this website officially launches. We appreciate how excited you must be,
given you've found this site ahead of time! Thanks for your support and patience. <3
<small><small>
_Psst! If you're in our beta and want to peek at this page ahead of time, check the working draft on the pad._
</small></small>

15
content/contributing.md Normal file
View file

@ -0,0 +1,15 @@
---
title: "Contributing"
description: "you're what makes Lix amazing <3"
date: "2024-05-01"
author: "Lix Team"
---
**Not yet available.**
This page is hidden until this website officially launches. We appreciate how excited you must be,
given you've found this site ahead of time! Thanks for your support and patience. <3
<small><small>
_Psst! If you're in our beta and want to peek at this page ahead of time, check the working draft on the pad._
</small></small>

2
content/faq.md
View file

@ -15,7 +15,7 @@ you're looking for, please feel free to ask over in the [community](/community).
Absolutely. A primary goal of the Lix project is compatibility, which means that we very much support
using Lix in any existing Nix or NixOS configuration.
Check out the [install page](/install) to see how to use Lix with your existing configurations.
Check out the [install page](/install_actual) to see how to use Lix with your existing configurations.
#### Q: What are your plans for flakes?

98
content/install.md
View file

@ -5,97 +5,11 @@ date: "2024-04-27"
author: "Lix Team"
---
Whether you're a new or returning user, **we're thrilled you've decided to pick up Lix!**
**Not yet available.**
Lix works out-of-the-box on most Linux and MacOS systems, including with system management tools
such as [home-manager](https://github.com/nix-community/home-manager) and
[nix-darwin](https://github.com/LnL7/nix-darwin) -- but, like any Nix-based system, some Nix background
knowledge is recommended before installation.
This install page is currently hidden until this website officially launches. We appreciate how excited you must be,
given you've found this site ahead of time! Thanks for your support and patience. <3
If you're new to the Nix ecosystem, you may want to check out some [community resources](/resources)
first, to get familiar with how Nix works.
## On NixOS
If you haven't already installed NixOS, do so using any upstream
[install image](https://nixos.org/download/#NixOS) and the instructions in the
[NixOS Manual](https://nixos.org/manual/nixos/stable/#sec-installation). Then, follow
the instructions for either:
- [flake-based configurations](/add-to-config#flake-based-configurations); or
- [non-flake configurations](/add-to-config#non-flake-configurations)
depending on how you prefer to configure your system.
## On an Existing `nix-darwin` Install
If you already have a [nix-darwin](https://github.com/LnL7/nix-darwin) installation, you
can use the same instructions as installing on a NixOS-based system. Follow the instructions
for either:
- [flake-based configurations](/add-to-config#flake-based-configurations); or
- [non-flake configurations](/add-to-config#non-flake-configurations)
depending on how you prefer to configure your system.
## On Any Other Linux/MacOS System
You can either perform a **new install**, or choose to
**upgrade an existing install** to Lix.
### New Installs
The easiest way to install Lix is to use the [Lix Installer](https://git.lix.systems/lix-project/lix-installer)[^1].
Open a terminal, and run the following command:
```sh
curl -sSf -L https://install.lix.systems/lix | sh -s -- install
```
The installer will guide you through installing Lix -- and once it's finished,
you'll have a full, working installation. If you're not sure what to do, now is a
great time to check out some of the [community's resources on Nix](/resources).
[^1]: a customized variant of the [Determinant Nix Installer](https://github.com/DeterminateSystems/nix-installer).
### Existing Installs
If you have an existing Nix installation, you should be able to upgrade by using a variant
of the `upgrade-nix` command.
<mark>
<b>This section is currently pending on a pull request, so these instructions are for proofreading only.</b>
</mark>
<br/>
<br/>
Thanks to Nix, we can actually ask Lix to upgrade your system directly. Run the following command:
```sh
sudo nix run --extra-experimental-features "nix-command flakes" \
"git+https://git.lix.systems/lix-project/lix" -- upgrade-nix
```
You should now have upgraded to Lix! You can verify this by asking the `nix` command
to report its version:
```sh
$ nix --version
nix (Lix, like Nix) 2.90.0-lix
```
As long as you see `Lix` in the output, you're good! If you're not sure what to do now, it's a
great time to check out some of the [community's resources on Nix](/resources).
## Having Trouble?
If you're having difficulty installing Lix, don't panic! Hop on over to our
[community page](/community), and check out the various ways to find help.
## Feedback?
If you have thoughts on these instructions, feel free to drop by our [community](/community),
or to [make a pull request to our website](git@git.lix.systems:lix-project/lix-website.git)!
<small><small>
_Psst! If you're in our beta and want to peek at the instructions ahead of time, they're in the git repo for this website._
</small></small>

101
content/install_actual.md Normal file
View file

@ -0,0 +1,101 @@
---
title: "Installing Lix"
description: "or: how to make your configuration Delicious"
date: "2024-04-27"
author: "Lix Team"
---
Whether you're a new or returning user, **we're thrilled you've decided to pick up Lix!**
Lix works out-of-the-box on most Linux and MacOS systems, including with system management tools
such as [home-manager](https://github.com/nix-community/home-manager) and
[nix-darwin](https://github.com/LnL7/nix-darwin) -- but, like any Nix-based system, some Nix background
knowledge is recommended before installation.
If you're new to the Nix ecosystem, you may want to check out some [community resources](/resources)
first, to get familiar with how Nix works.
## On NixOS
If you haven't already installed NixOS, do so using any upstream
[install image](https://nixos.org/download/#NixOS) and the instructions in the
[NixOS Manual](https://nixos.org/manual/nixos/stable/#sec-installation). Then, follow
the instructions for either:
- [flake-based configurations](/add-to-config#flake-based-configurations); or
- [non-flake configurations](/add-to-config#non-flake-configurations)
depending on how you prefer to configure your system.
## On an Existing `nix-darwin` Install
If you already have a [nix-darwin](https://github.com/LnL7/nix-darwin) installation, you
can use the same instructions as installing on a NixOS-based system. Follow the instructions
for either:
- [flake-based configurations](/add-to-config#flake-based-configurations); or
- [non-flake configurations](/add-to-config#non-flake-configurations)
depending on how you prefer to configure your system.
## On Any Other Linux/MacOS System
You can either perform a **new install**, or choose to
**upgrade an existing install** to Lix.
### New Installs
The easiest way to install Lix is to use the [Lix Installer](https://git.lix.systems/lix-project/lix-installer)[^1].
Open a terminal, and run the following command:
```sh
curl -sSf -L https://install.lix.systems/lix | sh -s -- install
```
The installer will guide you through installing Lix -- and once it's finished,
you'll have a full, working installation. If you're not sure what to do, now is a
great time to check out some of the [community's resources on Nix](/resources).
[^1]: a customized variant of the [Determinant Nix Installer](https://github.com/DeterminateSystems/nix-installer).
### Existing Installs
If you have an existing Nix installation, you should be able to upgrade by using a variant
of the `upgrade-nix` command.
<mark>
<b>This section is currently pending on a pull request, so these instructions are for proofreading only.</b>
</mark>
<br/>
<br/>
Thanks to Nix, we can actually ask Lix to upgrade your system directly. Run the following command:
```sh
sudo nix run --extra-experimental-features "nix-command flakes" \
"git+https://git.lix.systems/lix-project/lix" -- upgrade-nix
```
You should now have upgraded to Lix! You can verify this by asking the `nix` command
to report its version:
```sh
$ nix --version
nix (Lix, like Nix) 2.90.0-lix
```
As long as you see `Lix` in the output, you're good! If you're not sure what to do now, it's a
great time to check out some of the [community's resources on Nix](/resources).
## Having Trouble?
If you're having difficulty installing Lix, don't panic! Hop on over to our
[community page](/community), and check out the various ways to find help.
## Feedback?
If you have thoughts on these instructions, feel free to drop by our [community](/community),
or to [make a pull request to our website](git@git.lix.systems:lix-project/lix-website.git)!